https://github.com/vitor-silva27/guiadocampus-backend

API do 'Guia do Campus'! A API proporciona acesso fácil a informações essenciais sobre departamentos, salas de aula, serviços, horários no IFPI campus pedro II, simplificando a experiência dos alunos, professores e funcionários.
https://github.com/vitor-silva27/guiadocampus-backend

docker nodejs postgresql prisma-orm rest-api swagger typescript

Last synced: 9 days ago
JSON representation

API do 'Guia do Campus'! A API proporciona acesso fácil a informações essenciais sobre departamentos, salas de aula, serviços, horários no IFPI campus pedro II, simplificando a experiência dos alunos, professores e funcionários.

• Host: GitHub
• URL: https://github.com/vitor-silva27/guiadocampus-backend
• Owner: Vitor-Silva27
• Created: 2023-11-07T12:47:57.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-11T14:49:23.000Z (8 months ago)
• Last Synced: 2024-03-11T16:15:10.361Z (8 months ago)
• Topics: docker, nodejs, postgresql, prisma-orm, rest-api, swagger, typescript
• Language: TypeScript
• Homepage:
• Size: 222 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        








    

  


  
Guia do campus - API


  


    View front end repo

  



  Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Usage

    
Roadmap

    
Contributing

    
License

    
Contact

    
Acknowledgments

  


## About The Project



At IFPI Campus Pedro II, where I study, I noticed that despite having good infrastructure, internal communication faced challenges. Therefore, I developed a project using technologies such as QR codes and a website to enhance access to information about rooms and departments. The goal was to make communication more efficient and accessible, especially for students.

The basic idea is to distribute QR codes throughout the campus. Each department would have a QR code on the door that leads to the website's page for that specific department. This way, students would have instant access to information. If a student is not on campus, they can also access the website from home.

(back to top)


### Built With

#### Backend Technologies: 

* 

    

    

* 

    

    

* 

    

    

* 

    

    

* 

    

    

* 

    

    

* 

    

    

* 

    

    

(back to top)


## Getting Started

1. first you will need a .env file with the values:

```

PORT=XXXX (The port you want to run your application)

DATABASE_URL=(the url of a postgres database)

TOKEN_KEY=(a secret token to generate jwt)

S3_BUCKET=(the name of a bucket in aws s3)

S3_REGION=(the region of you aws s3 server)

S3_ACCESS_KEY=(the access key to your aws)

S3_SECRET=(the secret access key to your aws)

```

2. now to install the dependencies and run the app you will have two choices, using docker or without docker

#### with docker is quite easy. you have to run:

* docker

    ```sh

    docker build --pull --rm -f "Dockerfile" -t guiadocampus:latest "."

    ```

    run migrations to setup your database

    ```sh

    npx prisma migrate deploy

    ```

    when it finish just run:

    ```sh

    docker run -p 8080:80 guiadocampus:latest

    ```

then access your port 8080

#### if you don't have docker you will need node.js

* npm

  ```sh

    npm i

  ```

  run migrations to setup your database

    ```sh

    npx prisma migrate deploy

    ```

and to run:

* for development:

    ```sh

    npm run start:dev

    ```

* for production:

    ```sh

    npm run build

    ```

    ```sh

    npm run start

    ```

## Usage

to fully understand the usage see the [Documentation](https://guiadocampus-jln105qc.b4a.run/api)

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)