This is a Next.js project bootstrapped with create-next-app.
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
Our DB is a mongo instance hosted on atlas. To use it locally, you must have a .env.local file with the correct configuration.
This configuration must reference an existing DB with the necessaries collections created in them. If the collections are empty, they can be populated with given scripts.
The collections that have to be created by hands are features and games (both this collections must be under the same database).
Update your file .env.local with these new fields (update the CHANGE_ME values):
DB_USERNAME=CHANGE_ME
DB_PASSWORD=CHANGE_ME
DB_CLUSTER=evolution.dxcrvij.mongodb.net
DATABASE_NAME=CHANGE_ME
This configuration should be enough to communicate with the DB.
To reset the DB with basic data, the script ./dbScripts/loadData.sh can be ran. For this, you must have configured your DB and installed the mongo db shell and mongoimport.
The app is using Pusher as a web socket solution. It is necessary for this application to use web sockets in order to be notified of other players actions.
Here is the configuration that must be added to .env.local:
PUSHER_APP_ID=CHANGE_ME
PUSHER_KEY=CHANGE_ME
PUSHER_SECRET=CHANGE_ME
PUSHER_CLUSTER=CHANGE_ME
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.