Changeset 87614a5 for README.md

Timestamp:

06/11/22 12:46:20 (2 years ago)

Author:

anastasovv <simon@…>

Branches:

main

Children:

64dc53b

Parents:

6568bde

Message:

Blackjack prototype

File:

• README.md (modified) (1 diff)

README.md

@@ -1 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Caessino
 
-## Getting Started
+Firstly, create a .env file in the project's root directory and populate it like so:
 
-First, run the development server:
+HOME_URL="http://localhost:3000"
 
-```bash
-npm run dev
-# or
-yarn dev
-```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Now, in your console, navigate to the project's root directory and run:
 
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+docker-compose up
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+======== If you are configuring this project for the first time, do the following =========
 
-## Learn More
+We will now set up a dummy database, in order for the project to work.
+Note: The containers should be running in the background! (previously started with docker-compose up)
 
-To learn more about Next.js, take a look at the following resources:
+Open another console and run:
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+docker exec -it name_of_db_container /bin/bash
+psql -U postgres postgres < /usr/local/app/caessino.sql
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+==========================================================================================
 
-## Deploy on Vercel
+Now you are all set up.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+Enjoy your stay at Caessino.