Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheus369k/plann-er-api
A aplicação e o backend do repositório plann-er-web, sendo uma site para o usuário poder gerenciar a sua viagem.
https://github.com/matheus369k/plann-er-api
fastify node postman prisma sqlite typescript zod
Last synced: 10 days ago
JSON representation
A aplicação e o backend do repositório plann-er-web, sendo uma site para o usuário poder gerenciar a sua viagem.
- Host: GitHub
- URL: https://github.com/matheus369k/plann-er-api
- Owner: matheus369k
- License: mit
- Created: 2024-07-12T22:30:45.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-20T21:29:22.000Z (4 months ago)
- Last Synced: 2024-10-12T02:42:08.979Z (about 1 month ago)
- Topics: fastify, node, postman, prisma, sqlite, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Plann.er - BackEnd Node
[Descrição](#descrição)
|
[Iniciando](#iniciando)
|
[Dependências](#dependências)
|
[Rotas](#rotas)
|
[Licença](#licença)
## Descrição
A aplicação e o backend do repositório [plann-er-web](https://github.com/matheus369k/plann-er-web), sendo uma site para o usuário poder gerenciar a sua viagem:
- podendo marcar uma data de inicio e fim.
- adicionar convida, e enviar emails automaticamente aos convidados.
- podendo criar toda a rotina da viagem.
- convidar novo convidados logo apos a criação da viagem.
- atualizar as datas de incio, fim e local da viagem.
## Dependências
- Git - [baixar](https://git-scm.com)
- Node - [baixar](https://nodejs.org/pt)
- VSCode ( Recomendado ) - [baixar](https://code.visualstudio.com)
## Iniciando
Para testar o projeto na sua maquina, recomenda-se clonar o repositório em uma pasta local, como seguinte comando.
Digite no terminal
__HTTPS__
```
$ git clone https://github.com/matheus369k/plann-er-web.git
```
Acesse o projeto com seguinte comando
```
$ code plann-er-web
```
crie um arquivo __.env__ e adicione as variáveis ambiente a seguir
```
// url banco de dados
DATABASE_URL="file:./dev.db"
// url back-end
API_BASE_URL="http://localhost:333"
// url front-end
WEB_BASE_URL="http://localhost:5173"
// Port o valor padrão e 3333
PORT=3333
```
Acesse o terminal do projeto e digite
```
$ npm install
```
Logo apos digite
```
$ npx prisma generate
```
E por fim digite...
```
$ npm run dev
```
para rodar aplicação
## Rotas
Para saber quais são as rotas criadas na aplicação recomendo acessar o [documentação da api](https://nlw-journey.apidocumentation.com/reference), criado pela [rocketseat](https://www.rocketseat.com.br) em um evento em que criar aplicações desdo front ao back, com varias tecnologias diferentes.
## 📜Licença
Para o projeto fora usado a licença 🔗[MIT](/LICENSE.txt).