Senior Backend Engineer Test

This repository contains the code for the Senior Backend Engineer test at Rise. The project aims to demonstrate proficiency in creating a RESTful API using Node.js, Express, TypeScript, and PostgreSQL.

Getting Started

Follow these steps to set up and run the project on your local machine.

Clone this repository by typing in git clone https://github.com/Dunsin-cyber/senior-backend-eng-test.git
Make sure you have Docker and Docker Compose installed on your local machine.
Create a .env file in the project root and set the environment variables required for the app.For Example; DB_USER=your_db_username DB_PASSWORD=your_db_password DB_NAME=your_db_name
Build and start the project using Docker Compose: docker-compose -f docker-compose.yml up --build This command will set up the project, including the Node.js app and PostgreSQL database.
Access the app in your browser:

Open your browser and navigate to the URL and port you specified in the Docker Compose file.

Testing

Ensure database used for testing is a testing database. After confirming thim then feel free to run the test command yarn test

DOCS

Contributing

If you'd like to contribute to this project, feel free to fork the repository and submit a pull request.

License