https://github.com/oluizeduardo/glicocheck-api

API for diabetes management.
https://github.com/oluizeduardo/glicocheck-api

express javascript jwt knexjs nodejs rest-api sqlite3

Last synced: 3 months ago
JSON representation

API for diabetes management.

• Host: GitHub
• URL: https://github.com/oluizeduardo/glicocheck-api
• Owner: oluizeduardo
• License: mit
• Created: 2024-02-11T13:39:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T19:36:47.000Z (over 1 year ago)
• Last Synced: 2024-10-27T23:53:55.401Z (over 1 year ago)
• Topics: express, javascript, jwt, knexjs, nodejs, rest-api, sqlite3
• Language: JavaScript
• Homepage: https://glicocheck-api.onrender.com/api/ping
• Size: 1.13 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    



# Glicocheck API

API back-end for diabetes management.

Check out the front-end project available in [Glicocheck](https://github.com/oluizeduardo/glicocheck) repository.

## 🛠 Technologies applied

- Backend

    - NodeJS

    - [Express](https://expressjs.com/)

    - [Bcrypt](https://www.npmjs.com/package/bcrypt)

    - [Json Web Token](https://jwt.io/)

- Database

    - Postgres [Neon](https://neon.tech/home) (Production)

    - [SQLite](https://www.sqlite.org/index.html) (Development)

    - [KnexJS](https://knexjs.org/)

- Quality

    - Semantic code analysis

        - [ESLint](https://eslint.org/)

        - [Zod](https://zod.dev/)

        - [Github CodeQL](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)

- CICD

    - [GitHub Actions](https://docs.github.com/en/actions)

- Deploy

    - [Render](https://render.com/)

## 🚀 How to run locally

- Clone this project.

    - `git clone https://github.com/oluizeduardo/glicocheck-api.git`

- Access the root folder.

    - `cd glicocheck-api`

- Configure the environment variables.

    - `cp .env-example .env`

- Install all the dependencies.

    - `npm install`

- Run the server.

    - `npm run dev`

## 📡 API Endpoints

See the document of [endpoints](./docs/endpoints.md).

## 🔗 Code analysis

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-black.svg)](https://sonarcloud.io/summary/new_code?id=oluizeduardo_glicocheck-api)