Trekker app

This is a Ruby on Rails back-end for our Final Capstone project.

🔗 Link to Front-end React app 🖼

Built With

• Ruby 3.1.2
• Rails 7.0.3
• PostgreSQL

API Documentation 📄

🔗 Trekker API documentation

Getting Started

Prerequisites

• Ruby

Setup

To get a local copy up and running follow this simple step:

• Clone repository to your local machine:

$ git@github.com:dewslyse/trekker-back-end.git

This will create a directory in the name of the project folder.

• Navigate to project folder using

$ cd trekker-back-end

Install

• Install all gems and dependencies for the project by running:

$ bundle install

Create database

• In the config/ directory, create a new file with the name local_env.yml and add the following code:

DATABASE_USERNAME: 'Your-PostgreSQL-Username'
DATABASE_PASSWORD: 'Your-PostgreSQL-Password'

• Create the database by running:

$ rails db:create db:migrate db:seed

Usage

• Run rails s to start the server
• Open http://127.0.0.1:3000/ in your browser to use the app

Tests

• Run rspec to run the tests

Kanban board

Link to Kanban board

🔗 Trekker kanban board

🔗 Link to initial state of Kanban board

Number of Team members: 4

Authors

👤 Teshome Kurabachew

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Kemigabo Catherine

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Amina Buhari

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Selase

• GitHub: @dewslyse
• LinkedIn: Selase

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

Original design idea by Murat Korkmaz.

📝 License

This project is MIT licensed.