https://github.com/mohamedhegab/list
A RESTful API for Organizing the team work by making Lists and Cards
https://github.com/mohamedhegab/list
Last synced: 2 months ago
JSON representation
A RESTful API for Organizing the team work by making Lists and Cards
- Host: GitHub
- URL: https://github.com/mohamedhegab/list
- Owner: MohamedHegab
- Created: 2018-09-26T21:30:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-27T09:29:10.000Z (over 6 years ago)
- Last Synced: 2025-01-05T10:31:19.287Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LIST API
## Features
This Api has the following, and more:
- API Versioning
- Following JSONAPI conventions
- User Authentication using Devise
- User Authorization using CanCan
- Error and Exception Handling
- Rspec Integration Testing
- Rspec Unit Testing
## API HAS THE FOLLOWING RESOURCES
- User
- Lists
- Cards
- Comments
- Replies
#### This is POSTMAN COLLECTION for testing the endpoints
https://www.getpostman.com/collections/59750c4b4be2085c57bc
* Ruby version 2.5.0
* System dependencies
- [Devise](https://github.com/plataformatec/devise)
- [CanCanCan](https://github.com/CanCanCommunity/cancancan)
- [Rspec](https://github.com/rspec/rspec-rails)
* Configuration
* Database creation
Postgresql Database
```
mv config/application-example.yml config/application.yml
```
* Database initialization
```
bundle exec rake db:create && bundle exec rake db:migrate
```
* How to run the test suite
```
bundle exec rspec
```
## Authors
* **Mohamed Hegab** - *Initial work* - [MohamedHegab](https://github.com/MohamedHegab)