Files
kno-logic-api/README.md
2021-05-04 02:23:37 -04:00

31 lines
777 B
Markdown

# kno-logic-api
<p align="center">
<img src="https://imgur.com/P2nDq7b.png" width="180">
</p>
Kno-logic is a mobile learning platform with a short number of curated articles added daily for lifelong learners. This API was built with NodeJS and Express, and uses MongoDB as a database.
## Developing locally
If you would like to run the application you will need:
- NodeJS 14
- MongoDB Community
Install the latest version of [`Node.js`](https://nodejs.org/en/).
Install the latest version of [`MongoDB Community Server`](https://www.mongodb.com/community).
Clone the repository, and run the following:
```bash
# start database
mongod
# install dependencies
npm install
# server with hot reload (optional, requires nodemon)
nodemon
# running the server
node .
```