Skip to content

BodyBook is a training book for fitness enthusiasts 🏋️‍♂️

License

Notifications You must be signed in to change notification settings

gabrielmaialva33/bodybook-api

Repository files navigation


BookBook
BodyBook is a training book for fitness enthusiasts 🏋️‍♂️ powered by Deno 🦕

wakatime GitHub top language GitHub language count Repository size License GitHub last commit Maia

About   |    Technologies   |    Installation   |    Configuration   |    Documentation   |    License


🔖 About

BodyBook API is a REST API for the BodyBook application, which is a social network for fitness enthusiasts, where you can create events, share your workouts, follow other users and much more.


💻 Technologies

📦 Installation

# clone the repository
git clone https://github.com/gabrielmaialva33/bodybook-api.git
# enter the directory
cd bodybook-api
# cache the dependencies
deno cache --unstable deps.ts
# run the application
deno run --allow-net --allow-read --allow-write --allow-env --unstable src/server.ts

🔧 Configuration

copy the .env.example file and rename it to .env

# application
APP_NAME=BodyBook
APP_HOST=localhost
APP_PORT=3333
# database
PG_URL=postgres://postgres:postgres@localhost:5432/bodybook
PG_POOL_SIZE=20
PG_LAZY_POOL=true
# jwt
JWT_SECRET=secret
JWT_EXPIRES_IN=1d

📝 Documentation

# Use insomnia or postman to test the routes

file `bodybook-api.yaml` in root directory

✍️ Author

Maia
Maia

License

MIT License