readme.md

Pangaea

Pangaea backend assessment.

How To Use • How To Test • Credits • License •

How To Use

To run this application Node.js v15+ (which comes with npm) installed on your computer. Also you would need to install and setup MongoDb to make this work locally, you can also update the .env.example file after clone the project to point to a mongodb service online like mlab.

Then from your command line run:

Windows OS

# Clone this repository
$ git clone https://github.com/chyke007/pangaea-sh.git

# Go into the repository
$ cd pangaea-sh

# Run the app
$ ./start-server.sh

Mac OS

# Clone this repository
$ git clone https://github.com/chyke007/pangaea-sh.git

# Go into the repository
$ cd pangaea-sh

# Run the app
$ sh start-server.sh

How To Test

# Run test
$ npm test

Credits

This application uses the following open source packages:

• Typescript
• Node.js
• ExpressJs
• MongoDB
• Jest

License

MIT

---

chibuikenwa.com  ·  GitHub @chyke007  ·  LinkedIn @chibuikenwachukwu