Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/david-lanzz/bookstore-backend
https://github.com/david-lanzz/bookstore-backend
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/david-lanzz/bookstore-backend
- Owner: David-Lanzz
- License: other
- Created: 2023-08-20T07:48:03.000Z (about 1 year ago)
- Default Branch: alpha
- Last Pushed: 2024-03-06T03:58:48.000Z (9 months ago)
- Last Synced: 2024-03-06T20:03:21.922Z (8 months ago)
- Language: Ruby
- Size: 112 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bookstore Backend
## Table of Contents
- [Project Overview](#project-overview)
- [Features](#features)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)
## Project Overview
The Ruby on Rails backend API is designed to power a dynamic bookstore application currently in development. This application is specifically geared towards Nigerian students, aiding them in discovering course-related materials aligned with their respective schools, departments, and academic levels. By acting as a centralized hub for course materials and allowing student contributions, the platform aims to tackle challenges related to material accessibility, ultimately enriching the educational journey of users.
## Features
- Creation of Users, Schools, Departments, Levels, Categories, and Books
- User authentication and authorization on every request
- Correct and memoized database relationships
## Requirements
- Ruby version
- Rails version
- Any other dependencies or prerequisites necessary to run the project.
- Postman
## Setup
1. Clone the repository.
2. Navigate into the project directory.
3. Install dependencies: `bundle install`
4. Set up the database: `rails db:create && rails db:migrate`
5. (Optional) Seed the database: `rails db:seed`
6. Start the server: `rails server`
## Usage
When server is up and running, create a user e.g: http://localhost:3000/signup
(provide email and password)
OR
When server is up and running, signin as a user e.g: http://localhost:3000/login
(provide email and password)
## API Endpoints
List and briefly describe the available API endpoints along with their functionalities. Include details such as request methods, expected parameters, and sample responses.
| Endpoint | Method | Description |
|---------------------------|--------|----------------------------|
| `http://localhost:3000/signup` | POST | Create User |
| `http://localhost:3000/login` | POST | Create User |
| `http://localhost:3000/schools` | GET | See all schools |
| `http://localhost:3000/schools` | POST | Create a school | "name", "alias", "logo", "location"
| `http://localhost:3000/departments` | POST | Create a department | "name", "alias", "logo"
| `http://localhost:3000/departments` | GET | See all departments |
## Contributing
If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/fooBar`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add some fooBar'`).
5. Push to the branch (`git push origin feature/fooBar`).
6. Create a new Pull Request.
## License
Indicate the license under which your project is distributed. For example:
This project is licensed under the [MIT License](./LICENSE.md).