https://github.com/schoolseat/api

Our actual API
https://github.com/schoolseat/api

api-rest javascript javascript-api mongodb mongoosejs

Last synced: about 2 months ago
JSON representation

Our actual API

• Host: GitHub
• URL: https://github.com/schoolseat/api
• Owner: schoolseat
• License: gpl-3.0
• Archived: true
• Created: 2021-05-31T10:59:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-30T09:00:34.000Z (over 2 years ago)
• Last Synced: 2024-09-24T17:33:03.900Z (about 2 months ago)
• Topics: api-rest, javascript, javascript-api, mongodb, mongoosejs
• Language: TypeScript
• Homepage:
• Size: 763 KB
• Stars: 6
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 SchoolSeat API 


## ✨ Features

- JWT Authentication.

- CORS [(Cross-Origin Resource Sharing)](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/CORS).

- Database with [MongoDB](http://mongodb.com/).

## 🛠 Usage

1. Clone this repository.

2. Install all dependencies with `yarn install` or `npm install`.

3. Add a `.env` file based on [.env.example](https://github.com/schoolseat/api/blob/main/.env.example).

4. Start development server with `yarn dev` or `npm run dev`.

## 🎨 Linting

- Run code syntax and format checking using `yarn lint` or `npm run lint` which runs eslint.

- Automatically fix lint errors with `yarn lint:fix` or `npm run lint:fix`.

## 📝 TODO

- [x] Check permissions in controllers.

- [ ] Location-based login verification.

- [ ] Login with Google.

- [X] Email...

## 📄 License

- Code: [GPL v3](https://github.com/schoolseat/api/blob/master/LICENSE)

  
Made with ❤️ by SchoolSeat Team