Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 1.71 KB

README.md

File metadata and controls

87 lines (53 loc) · 1.71 KB
Raw

unknown art

https://unknown-art.club/ is the club that will introduce you to arty and independent bookstores, all over the world.

Technicalities

This is a Next.js application, based on React.js, Typescript and CSS Modules.

npm is the package manager used.

First, install the dependencies:

npm i

Then, start the local server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Lint:

npm run lint

Fix:

npm run fix

Testing

Unit Tests are built with Vitest.

npm run test:unit

E2e Tests are built with Playwright.

npm run test:e2e

Development configuration

.env

.env configuration needs to be set on .env.local

MongoDb

Option 1: Remote

Mongodb security settings for local development require an IP whitelist to work.

Network Access -> IP Access List -> 0.0.0.0/0

Set in .env the remote configuration

NEXT_MONGO_DB_URL=mongodb+srv://[MONGODB_USER]:[MONGODB_PASSWORD]@[MONGODB_URL]/

Option 2: Local with Docker Compose

Set in .env the dockerized local configuration

NEXT_MONGO_DB_URL="mongodb://myUser:myPassword@localhost:27017/"

You can use Docker Compose to run a MongoDB instance for local development.

First, make sure you have Docker and Docker Compose installed on your machine.

Then, you can start and afterwards end the MongoDB instance with the following command:

docker-compose -f docker-compose.yml [up|down]