https://github.com/ebenjs/keep-backend
https://github.com/ebenjs/keep-backend
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ebenjs/keep-backend
- Owner: ebenjs
- Created: 2021-08-29T18:17:00.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-10-16T11:35:23.000Z (over 3 years ago)
- Last Synced: 2025-04-01T19:26:51.059Z (over 1 year ago)
- Language: JavaScript
- Homepage: keep-backend.vercel.app
- Size: 114 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Keep Backend
Backend of the open source note keeping project.
---
## Stacks used
MongoDB database
Express Framework
## Install
- Clone this repository
```bash
git clone https://github.com/ebenezer10/keep-backend.git
```
- Install dependencies
```bash
npm install
```
- Recreate .env
You must create a ```.env``` file at the root of the project based on the ```.env.example``` file.
- Run tests
- Launch server
Before launching server ensure that ```mongod``` service is started and running properly.
```bash
DEBUG=myapp:* npm start --watch
```
## Contributing
Before contributing to this project, read [CONTRIBUTING.md](https://github.com/ebenezer10/keep-backend/blob/main/CONTRIBUTING.md)