mirror of
https://github.com/JonasunderscoreJones/jonas_jones-api.git
synced 2025-10-23 00:59:18 +02:00
36 lines
778 B
Markdown
36 lines
778 B
Markdown
# jonas_jones-api
|
|
|
|
API supporting the Jonas_Jones project infrastructure.
|
|
|
|
## Installation
|
|
|
|
As of now, the project has no proper production build and unless the proper environment variables are set, the API will not work.
|
|
|
|
|
|
Clone the repository and install the dependencies.
|
|
```bash
|
|
git clone git@github.com:J-onasJones/jonas_jones-api.git
|
|
cd jonas_jones-api
|
|
cargo build
|
|
```
|
|
|
|
## Usage
|
|
|
|
To run the API, simply run the following command.
|
|
```bash
|
|
cargo run
|
|
```
|
|
|
|
If you want to run the API in a production environment, you will need to set the following environment variables.
|
|
|
|
- API_PORT
|
|
- API_IP
|
|
- LASTFM_API_KEY
|
|
- LASTFM_API_SECRET
|
|
|
|
```bash
|
|
export API_PORT={port}
|
|
export API_IP={ip_address}
|
|
export LASTFM_API_KEY={lastfm_api_key}
|
|
export LASTFM_API_SECRET={lastfm_api_secret}
|
|
```
|