Skip to content

Commit e9faa2b

Browse files
authored
Merge pull request #3 from WebMo21/develop
Documentation Update
2 parents 1e40a52 + 95d12dc commit e9faa2b

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
# Fitness Time Backend
1+
# 🏋️ Fitness Time - Workout Planner Backend
2+
3+
A lightweight backend enabling users scheduling and organization of fitness activities.
4+
5+
![Alt Text](./assets/img/backend-code-and-route-preview.gif)
6+
7+
## ✨ Features
8+
9+
- Provides running Node.js Backend with REST API
10+
- Connection to Heroku database working and Fixed SSL error
11+
- File structure following principles of clean code has been implemented in good faith
12+
- Database migration files and example seeding data
13+
- Implemented full CRUD support for the 3 resources users, workouts and weekly-workout-plans with router, controller and service layer abstraction
14+
- REST API has API tests persisted within within the thunder-tests folder for documentation and execution
15+
- Provided structured documentation for the project
16+
17+
## 🤖 Technologies
18+
19+
- [Express.js](https://expressjs.com) node backend server running providing a fast & minimalist REST API
20+
21+
- [Knex.js](http://knexjs.org) query builder used to handle migrations, seeding and connection to database
22+
- [PostgreSQL](https://www.postgresql.org) relational database connected with the help of free hosting on [Heroku](https://heroku.com)
23+
- Continuous Integration / Continuous Deployment Pipeline achieved with [Heroku](https://heroku.com)
24+
- [Thunder Client](https://www.thunderclient.io) as an alternative to Postman for version controlled and easy documented REST API tests
225

326
## Development & Ideas
427

88.4 MB
Loading

0 commit comments

Comments
 (0)