In this repository you will find all files and information related the the on-boarding project for the backend server that will be created. On top of that, you can also find everything related to the database created for the project.
The goal of the project is to create and interact with a database using GraphQL and Prisma. So far, an entity called user has been created, which can be manipulated in any way using CRUD commands. Once an user is created, it can login and perform a number of operations that only a logged in user can do, such as creating other users and finding them on the database.
This project uses TypeScript, NodeJS, Apollo, GraphQL and Prisma with PostgreSQL. NodeJS is being used for us to run JavaScript code in the backend as a means to create a server. Typescript is being used to make JavaScript a statically typed language, making development easier and more straightforward. Apollo and GraphQL are being used together to manage and test requests that can be made with the schemas created in the project. Lastly, Prisma and PostgreSQL are being used to manage the database, allowing us to use object relational mapping to create and handle our data.
So far, all the tools listed above have been implemented and tested in their most basic form. To run the code on your machine, you can follow the steps below.
Before cloning the repository to your machine, make sure you have Node.js and a PostgreSQL database running on your machine. In order to get an instance of a PostgreSQL running on your machine, you can use Docker. If using Docker on Linux, you can start it by running
sudo systemctl start dockerYou can also try running docker run hello-world to check if everything is in order.
After checking that everything is okay, you can run the following command to start the PostgreSQL server.
docker compose up -dIf everything went well so far, you can setup your .env file. A .env.test has been provided, whose contents you can copy, change its credentials that are in docker-compose-yml file and add it to a .env file. If for whatever reason you wish to name your .env files to something else, don't forget the change the appropriate scripts in packages.json, otherwise the commands below will not work.
Once you have you environments setup, you can run the command below
npm startThis command will start the Apollo server on port 4000. From here on out you can add other users in the database as you see fit using the Apollo Server on your browser throgh the mutation implemented in the resolvers.
Also, there are several other script commands that have been implemented in order to run the tests, run the server with the test database and open the prisma studio with the test database, some of these commands with their explanation can be seen below.
npm run migrateServer to apply the changes made do schema.prisma in the development server npm run migrateTest to apply the changes made do schema.prisma in the test servernpm run startTest to start the server with the test databasenpm run studioTest to open prisma studio with the test databasenpx prisma studo to open prisma studio with the development database npm test to run the testsFurthermore, error handling has been implemented for the queries and mutations implemented thus far, covering the most common error cases and handling them appropriately. Also, as mentioned above, an authentication system has been implemented, which will allow a user to perfom certain actions only if he is logged in and then given a valid token, which will be checked with every operation.
Besides all of that, a series of tests have been created to check if the code is working as expected, which covers all of the above mentioned features.