https://github.com/santana-victor/api-meus-projetos

Esse projeto é a API REST utilizada no meu portfólio.
https://github.com/santana-victor/api-meus-projetos

fastify mongodb mongodb-atlas nodejs prisma-orm typescript

Last synced: 11 days ago
JSON representation

Esse projeto é a API REST utilizada no meu portfólio.

• Host: GitHub
• URL: https://github.com/santana-victor/api-meus-projetos
• Owner: Santana-Victor
• Created: 2024-10-02T17:42:35.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T23:47:48.000Z (2 months ago)
• Last Synced: 2024-10-27T05:04:02.259Z (about 2 months ago)
• Topics: fastify, mongodb, mongodb-atlas, nodejs, prisma-orm, typescript
• Language: TypeScript
• Homepage:
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 API REST - Meus Projetos 





![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)

![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

![Fastify](https://img.shields.io/badge/fastify-%23000000.svg?style=for-the-badge&logo=fastify&logoColor=white)

![Prisma](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white)

![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)




## Projeto

Esse projeto é a API REST utilizada no meu portfólio, tendo como objetivo retornar os dados dos meus projetos que estão salvos em um Banco de Dados no [MongoDB Atlas](https://www.mongodb.com/products/platform/atlas-database).

## Tecnologias Utilizadas

Esse projeto foi desenvolvido com as seguintes tecnologias:

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

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

- [Fastify](https://github.com/fastify/fastify/)

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

- [MongoDB](https://www.mongodb.com/)

## Como Executar

1.  Clone o repositório e acesse a pasta do projeto

    ```shell

    git clone https://github.com/Santana-Victor/api-meus-projetos.git

    cd nome-do-repositorio

    ```

2.  Instale os pacotes utilizando o comando `npm install`

3.  Vá até o arquivo `.env.example` na raiz do projeto e renome-o para `.env`

4.  Ainda no arquivo `.env` preencha as variáveis de ambiente, instruções abaixo:

       ```shell

       DATABASE_URL=            # Insira aqui sua string de conexão com o MongoDB

       DOMAIN_ACCESS_ALLOWED=   # Insira aqui a URL do seu front-end, por exemplo: http://localhost:5173

       ```

6.  Execute o projeto com o comando `npm run dev`

## Exemplo

Utilizando o Postman ou alguma outra ferramenta de teste de API's de sua preferência, siga os passos abaixo:

1. Endpoint:

    ```shell

    http://localhost:8080/projects

    ```

2. Exemplo de resposta da API:

   ```shell

   [

    {

        "id": 1,

        "title": "Clima",

        "onlineProjectURL": "https://app-weather-sand-eight.vercel.app/",

        "repositoryProjectURL": "https://github.com/Santana-Victor/app-weather",

        "imageProjectURL": "https://raw.githubusercontent.com/Santana-Victor/imagens-projetos/refs/heads/main/app-weather-preview.png",

        "imageWidth": 430,

        "imageHeight": 408

    },{...},{...},{...}

   ]

   ```

### Front-end

Link do [repositório do Front-end](https://github.com/Santana-Victor/Portfolio)