- Node Version Manager - NVM (optional)
- Node.js (18.16.0 or superior)
- Docker (optional)
- Clone the API repository | Clone o repositório da API:
git clone https://github.com/DjdogeGamer/CEN-API.git
- Navigate to the API directory | Navegue até o diretório da API:
cd CEN-API
- Install dependencies | Instale as dependências:
npm install
-
Rename the
.env.example
file to.env
| Renomeie o arquivo.env.example
para.env
-
Edit the
.env
file and set the following variables | Edite o arquivo.env
e defina as seguintes variáveis:
- Start the Server | Inicie a Server:
npm start
- Acesse a API em
http://localhost:3000
.
- Build the Docker image | Construa a imagem Docker:
docker build -t cen-api .
- Run the Docker image | Execute a imagem Docker:
docker run -d -p 3000:3000 cen-api
- Access in | Acesse Em
http://localhost:3000
.
A API está hospedada no Google Cloud Platform (GCP) e pode ser acessada em:
The API is hosted at Google Cloud Platform (GCP) and it can be accessed in:
- Login to the GCP Account | Faça login no GCP Account:
gcloud auth login
- Set the GCP Project | Defina o projeto GCP:
gcloud config set project cen-api
- Deploy the API | Implante a API:
gcloud app deploy
-
GET /query?sqlQuery=YOUR_SQL_QUERY&fileName=db.sqlite
: Executa uma query no banco de dados e retorna o resultado em um arquivo JSON | Execute a query in the database and return the result in a JSON file. -
GET /asset?fileName=filename.extension
: Retorna um arquivo de mídia | Returns a media file.
Se você encontrar algum problema ou tiver alguma sugestão de melhoria, sinta-se à vontade para abrir uma issue ou enviar um pull request. | If you find any problems or have any suggestions for improvement, feel free to open an issue or send a pull request.