Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.36 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.36 KB
Raw

The BucketList

The Bucket List is a web application developed using RoR (Ruby on Rails) and React JS. It aims to provide users with a seamless and comprehensive platform where they can effortlessly create, organize, and monitor the progression of their diverse aspirations, goals, and dreams, thereby comprising their esteemed bucket list.

Technologies Used

  1. ReactJS: Used to develop the frontend of the project, providing a smooth user experience.

  2. Ruby on Rails (RoR): Used for backend development, providing a robust and scalable server-side framework.

  3. SQLite3: Used for the development environment to store and update tables containing created items and categories.

  4. PostgreSQL: Used as the production database environment.

  5. Active Record: Object-relational manager for the database, facilitating easy database interactions and queries.

Geting Started /Setup

  1. The project's frontend has already been deployed on Vercel. You can use this endpoint to access it
https://front-q8u9iaboo-kelvinkirui.vercel.app/home

Alternatively

  1. Clone the repo
git clone git@github.com:JohnKj01/rails-bucket-list-backend.git

Navigate to the project directory using:

cd rails-bucket-list-backend

Install the required dependencies:

bundle install

Set up the database:

rails db:reset

Start the Rails server:

rails s

The API is now running on http://localhost:3000.

You are now ready to explore the Bucket List Project, create your bucket list items, and track your progress towards achieving your goals and dreams!

Contributing

We welcome contributions to the Bucket List Project. If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository or submit a pull request.

Before making any significant changes, please discuss them with the project maintainers to ensure they align with the project's goals and direction.

License and copyright

  • The code in this project is licensed under the terms of the General Public License (GPL-3.0).

  • You are granted permission to use, modify, and contribute to the project under the conditions outlined in the GPL-3.0 license.

  • It is important to preserve and include the copyright and license notices in all copies and distributions of the project.

Author

This project was created by Samuel, John, Najma, Kelvin and Allan