An open API service indexing awesome lists of open source software.

https://github.com/sougabriel/maker-lab-api

A RESTful API for Maker Culture Laboratories. This API use JWT for authentication and block endpoints by user access level.
https://github.com/sougabriel/maker-lab-api

api-rest culture-maker jwt jwt-auth jwt-authentication nestjs prisma-orm restful-api typescript

Last synced: 2 months ago
JSON representation

A RESTful API for Maker Culture Laboratories. This API use JWT for authentication and block endpoints by user access level.

Awesome Lists containing this project

README

          

# Maker Laboratory API

![GitHub repo size](https://img.shields.io/github/repo-size/sougabriel/maker-lab-api?style=for-the-badge)
![GitHub language count](https://img.shields.io/github/languages/count/sougabriel/maker-lab-api?style=for-the-badge)
![GitHub forks](https://img.shields.io/github/forks/sougabriel/maker-lab-api?style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/sougabriel/maker-lab-api?style=for-the-badge)

> This project is a RESTful API for Maker Culture Laboratories. This API use JWT for authentication and block endpoints by user access level.

## Improvements

The project is still under development and the next updates will focus on the following tasks:

- [ ] Create Unit Tests
- [ ] Build a Documentation
- [ ] Implement Cache for Requests

## 🚀 Project Setup

In the root directory of project run the following command:

```bash
$ npm install
```

## 🗔 Compile and Run the Project

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

## 😄 How to Contribute

Wanna make part of this project? See [How to contribute here](CONTRIBUTING.md) and the [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./CODE_OF_CONDUCT.md).

## 📝 License

This project is under [MIT license](./LICENSE).