Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mwafrika/final_capstone_backend
Yamaha Motor App is a motorcycle reservation platform that allows customers to book their motorcycle remotely within a defined time frame
https://github.com/mwafrika/final_capstone_backend
activestorage github jsonwebtoken postgresql postman rails ruby
Last synced: about 1 month ago
JSON representation
Yamaha Motor App is a motorcycle reservation platform that allows customers to book their motorcycle remotely within a defined time frame
- Host: GitHub
- URL: https://github.com/mwafrika/final_capstone_backend
- Owner: mwafrika
- License: agpl-3.0
- Created: 2022-07-15T08:05:41.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-07-30T08:17:02.000Z (over 2 years ago)
- Last Synced: 2024-10-02T09:05:23.294Z (about 2 months ago)
- Topics: activestorage, github, jsonwebtoken, postgresql, postman, rails, ruby
- Language: JavaScript
- Homepage: https://yamaha-motor.netlify.app/
- Size: 1.01 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TABLE OF CONTENTS
## About The Project
> **Yamaha Motor App** is a motorcycle reservation platform that allows customers to book their motorcycle remotely within a defined time frame.
### ERD diagram
### Built With
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- POSTGRESQL _~> 14.x_
- Ruby _~> 3.1.x_
### Installation
1. Clone the repo:
```sh
git clone [email protected]:mwafrika/final_capstone_backend.git
```
2. go to the project folder:
```sh
cd final_capstone_backend
```
3. Install the dependencies:
```sh
bundle install
```
4. Set the following the environment variables for database:
```
DATABASE_NAME
USER_PASSWORD
USER_NAME
```
5. Create database:
```sh
rails db:create
```
6. Run the migrations:
```sh
rails db:migrate
```
7. Seed the database:
```sh
rails db:seed
```
8. Generate a secret key:
```sh
rails secret
```
9. Edit your credentials.yml.enc file:
```sh
$env:EDITOR="notepad"
rails credentials:edit
```
11. Set the credentials to decode the JWT
```sh
secret_key_base:
```
12. Launch the server:
```sh
rails s -p 8000
```
## Usage
_For more Info on how to use the API, please refer to the [Yamaha motor API Documentation](https://yamaha-motor.herokuapp.com/api-docs/index.html)_
## Kanban board
👉 [Kanban board link](https://github.com/mwafrika/final_capstone_frontend/projects/1)
👉 This project was authored by Four contributors as described in the the Authors section bellow.
👉 Please use this [link](https://github.com/mwafrika/final_capstone_frontend) to go to the front-end part of this project.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Please, take a look at [open issues](https://github.com/mwafrika/final_capstone_backend/issues) for a full list of proposed features (and known issues).
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Authors
👤 **Mwafrika Josué**
- GitHub: [@mwafrika](https://github.com/mwafrika)
- LinkedIn: [@mwafrika-mufungizi](https://linkedin.com/in/mwafrika-mufungizi)
- Twitter: [@mwafrikamufung1](https://twitter.com/mwafrikamufung1)
- Website: [mwafrika.me](https://mwafrika-portfolio-app.herokuapp.com/)
👤 **Bushra Mostafa**
- GitHub: [@bushra](https://github.com/)
- LinkedIn: [bushra](https://www.linkedin.com/in/)
- Twitter: [@bushra](https://twitter.com/)
👤 **Abenezer Tilahun**
- GitHub: [Abenezer Tilahun](https://github.com/)
- Website: [Abenezer Tilahun](https://codingfries.com)
- LinkedIn: [Abenezer Tilahun](https://www.linkedin.com/in/)
## Acknowledgments
- Original design by [Murat Korkmaz](https://www.behance.net/muratk).
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Img Shields](https://shields.io)
- [React Icons](https://react-icons.github.io/react-icons/search)
## License
Distributed under the **AGPL** License. See [`LICENSE`](./LICENSE) for more information.