This code is my response to Bibliu's old tech test. It is an express server with a mongodb database and mongoose object modeling.
The database contains User, Institution and Book models which can be accessed by three routes defined by express:
POST /users/signin: verifies user credentials with the passport library which then registers a session with express-session.POST /users/create: creates user with a name, email, role and password.- At the time of saving, the user model will also use the registered email domain to associate users with their respective institution.
GET /books: returns a list of books offered by each user's respective institution to the client.
This program uses Docker to facilitate set up. However, you must have docker installed in order to use it.
The easiest way to do this is to install Docker Desktop. You can find installation instructions and downloads for Docker Desktop at this link.
Once you have Docker Desktop installed, running the server is easy. Simply navigate to the directory you would like to save this repository to and run the following command:
git clone https://github.com/dackq/express-code-challenge.git
Then navigate into the new directory:
cd express-code-challenge/
Afterwards, you need to use Docker to set up the database and run the server. This process is saved in the npm start script, so simply run:
npm start
This will create two docker containers and get them up and running. One is the server and the other is the database. The database will be pre-seeded with institution and book documents.
To stop the server, type ctrl-c into the terminal where it is running. Anytime that you would like to run the server again, simply re-use the command npm start in the project directory.
Because docker containers have their own filesystem, in order to run the tests on the server you will need to connect a new bash terminal to the container running the server.
To do this run the following script while the server is already running:
npm run connect
This will start a bash terminal session within the container. From here, you can run npm test to see the test results.
Documentation for the classes and modules used in the server can be acessed via github pages at this link.
If you would like, they can also be accessed at localhost:3000/docs once the server has been started.