Skip to content

Commit

Permalink
Merge pull request #3 from WebMo21/develop
Browse files Browse the repository at this point in the history
Documentation Update
  • Loading branch information
SaschaWebDev authored Jun 26, 2021
2 parents 1e40a52 + 95d12dc commit e9faa2b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# Fitness Time Backend
# 🏋️ Fitness Time - Workout Planner Backend

A lightweight backend enabling users scheduling and organization of fitness activities.

![Alt Text](./assets/img/backend-code-and-route-preview.gif)

## ✨ Features

- Provides running Node.js Backend with REST API
- Connection to Heroku database working and Fixed SSL error
- File structure following principles of clean code has been implemented in good faith
- Database migration files and example seeding data
- Implemented full CRUD support for the 3 resources users, workouts and weekly-workout-plans with router, controller and service layer abstraction
- REST API has API tests persisted within within the thunder-tests folder for documentation and execution
- Provided structured documentation for the project

## 🤖 Technologies

- [Express.js](https://expressjs.com) node backend server running providing a fast & minimalist REST API

- [Knex.js](http://knexjs.org) query builder used to handle migrations, seeding and connection to database
- [PostgreSQL](https://www.postgresql.org) relational database connected with the help of free hosting on [Heroku](https://heroku.com)
- Continuous Integration / Continuous Deployment Pipeline achieved with [Heroku](https://heroku.com)
- [Thunder Client](https://www.thunderclient.io) as an alternative to Postman for version controlled and easy documented REST API tests

## Development & Ideas

Expand Down
Binary file added assets/img/backend-code-and-route-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e9faa2b

Please sign in to comment.