42 School Web Project. This is the backend for 42-matcha. It will be managed as a set of microservices, each presenting an API used by the dispatcher. The stack is based on Node.js and Express.js.
TOC:
The server should be running a PostgreSQL 12 database and a set of related environment variables should be defined in a .env file at the root of the directory.
The server should be running a PostgreSQL database, whose user, password, and URL will be defined in a .env file.
To run the server you should have a .env file in the server directory, containing the following keys:
DB_URL=[db_server_url i.e: localhost]
DB_PORT=[db_server_port i.e: 5432]
DB_NAME=[db_name i.e:matcha]
DB_USER=[db_user]
DB_PASSWORD=[db_password]
NODE_ENV=[development/production]
PORT=[server port, default is `:8001`]You should have a postgresql instance launched on the machine.
You will need to pass the postgresql database username, password, url, port and database name in an .env environment file in the server directory.
Connect to localhost:8001 to access the server.
Initial setup:
- Step 1: run the
upgrade-db.shscript. It uses the.envfile to figure out the URL, username and password. - Step 2 (optionnal): run
npm testto check that everything is in order. - Step 3: run
npm start. The server will be listening on the specified port.
Current: Monolith backend. Single node.js server running all services. The app tries to follow the Clean Architecture pattern.
- domain: framework agnostic logic, independant from the implementation
- gateways: I need to find a way to implement interfaces in js.
- routes/db/validation: external services that implement the domain requirements.
Future: The server will be run as the following microservices:
- authentication
- user management
- chat
- notification
The server uses db-migrate to manage the database migrations.
All migrations are described as SQL in the migrations folder.
Internally, the database connections and queries are managed through pg-promise