Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xdk78/ren-backend
Example backend for series/movies progress tracker
https://github.com/xdk78/ren-backend
api backend movies series tracker typescript
Last synced: 10 days ago
JSON representation
Example backend for series/movies progress tracker
- Host: GitHub
- URL: https://github.com/xdk78/ren-backend
- Owner: xdk78
- License: mit
- Created: 2018-06-23T20:28:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T20:45:54.000Z (almost 2 years ago)
- Last Synced: 2024-12-26T23:24:54.603Z (15 days ago)
- Topics: api, backend, movies, series, tracker, typescript
- Language: TypeScript
- Homepage:
- Size: 1.89 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ren Backend
## ✋ Contributing
If you want to help with the project, you can have a look at some [issues](https://github.com/xdk78/ren-backend/issues). All help is much appreciated 🍻
## 🏃 Running application
### Prerequisites
- [Node.js](https://nodejs.org/en/download/)
- [MongoDB v3.6](https://www.mongodb.com/download-center)
### 🤘 Let's start
- Clone repo
- Via https
```
git clone https://github.com/xdk78/ren-backend.git
```
- Via ssh
```
git clone [email protected]:xdk78/ren-backend.git
```
- Now enter to app dir
```
cd ren-backend
```
- Install depedencies
```
npm i
```
- Create `.env` files ([example](.env.example) in repo)
- for development `.env`
- for production `.env.production`
- Running application
```
npm run dev
```
- Running application in production mode
```
npm run build && npm start
```
- Running linter
```
npm run lint
```
- Running tests
```
npm test
```
## Docs
[Docs](docs/index.md)
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.