https://github.com/mateusfs99/planner-api

Node.js API of Planner application.
https://github.com/mateusfs99/planner-api

fastify node-js prisma sqlite

Last synced: 3 months ago
JSON representation

Node.js API of Planner application.

• Host: GitHub
• URL: https://github.com/mateusfs99/planner-api
• Owner: MateusFS99
• License: mit
• Created: 2024-07-10T00:27:22.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-07-18T02:34:41.000Z (5 months ago)
• Last Synced: 2024-10-11T02:42:12.587Z (3 months ago)
• Topics: fastify, node-js, prisma, sqlite
• Language: TypeScript
• Homepage:
• Size: 53.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



This is the backend of the Planner application, developed with Node.js and Fastify, using Prisma for ORM and SQLite as the database.

## About 🎯

The planner-api provides a RESTful API that serves as the backend for the Planner application's frontend.

## Technologies 💻

- [Node](https://nodejs.org)

- [Typescript](https://www.typescriptlang.org)

- [Fastify](https://fastify.dev)

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

- [Prisma](https://www.prisma.io)

- [Nodemailer](https://nodemailer.com)

## Installation 🛠

Follow the steps below to set up and run the project locally.

### Steps

1. Clone the repository:

   ```bash

   git clone https://github.com/MateusFS99/planner-api.git

   ```

2. Navigate to the project directory:

   ```bash

   cd planner-api

   ```

3. Install the dependencies:

   ```bash

   npm install

   ```

4. Create a .env file at the root of the project and configure the environment variables as specified in the .env.example file.

5. Run the Prisma migrations:

   ```bash

   npx prisma migrate dev

   ```

6. Start the server:

   ```bash

   npm run dev

   ```

## License ®️

This project is under the MIT license. Consult the [LICENSE](LICENSE) for details.