https://github.com/zigamacele/kisetsu
Express API for tracking seasonal anime
https://github.com/zigamacele/kisetsu
anime api backend express mongodb typescript
Last synced: about 1 month ago
JSON representation
Express API for tracking seasonal anime
- Host: GitHub
- URL: https://github.com/zigamacele/kisetsu
- Owner: zigamacele
- Created: 2023-07-03T18:46:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-18T15:29:52.000Z (almost 3 years ago)
- Last Synced: 2025-05-14T12:21:15.661Z (about 1 year ago)
- Topics: anime, api, backend, express, mongodb, typescript
- Language: TypeScript
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kisetsu
Kisetsu is an API designed for anime enthusiasts, allowing them to conveniently save and retrieve information about their favorite anime series. Whether you're an avid anime watcher or a casual viewer.
## Manual Installation
Clone the repo:
```bash
git clone https://github.com/zigamacele/kisetsu.git
cd kisetsu
```
Install the dependencies:
```bash
npm install
```
Set the environment variables:
```bash
cp setup/.env.example .env
# open .env and modify the environment variables
```
## Commands
Running in development:
```bash
npm start
# or
npm run dev
```
Running tests:
```bash
npm run test
# or run separate files with
npm run test -- user.test.ts
```
Running in production:
```bash
# build
npm run build
# start
npm run prod
```
## Environment Variables
The environment variables can be found and modified in the `.env` file.
```bash
##Port
PORT =
#JWT Secret
SECRET =
#URL for Monogo DB
DB_HOST =
```
### API Endpoints
List of available routes:
**Auth routes**:\
`POST api/register` - Register\
`POST api/login` - Login
**Anime routes**:\
`POST api/anime/create` - Create new anime\
`PUT api/anime/update/:id` - Update global anime\
`DELETE api/anime/delete/:id` - Delete global anime
**User routes**:\
`GET api/user/list` - Get users list\
`GET api/user/list/:id` - Get users anime\
`PUT api/user/list/:id` - Update users anime\
`DELETE api/user/list/:id` - Delete users anime\
`GET api/user/schedule` - Get users schedule