📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Website Mockup 📱 💻 🖥️
    • 🖺 Entity Relationship Diagram
  • Kanban Board
  • React Frontend
  • API Documentation
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• ❓ FAQ

• 📝 License

📖 EducateMe Backend

• Homepage

EducateMe is a course booking platform that allows a user to reserve a course taken by a specific teacher of their liking. It is built and connected by using two different repos: Back-end(Rails) and Front-end(React/Redux).

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails

Database

• PostgreSQL

Key Features

• Course List endpoints
• Authentication to access Courses, Teacher and Reservations
• Authenticated Users can add/remove a reservations

(back to top)

📇 Entity Relationship Diagram

React Frontend

• Here is the Frontend part of the project Front End

🚀 kanban board

List of requirements:

• There are four team members in total.
• Kanban board LINK.

Screenshot of the kanban board:

🚀 Live Demo

• [Live Demo] 😃

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need: Git and Ruby

 gem install rails

Install

Install this project with: (Check the your ruby version first and if it is different then you can add your version to the gemfile)

  bundle install

• To run the rails server, strictly follow the instructions layed out the screenshot:
• NB: If you have a config/credentials.yml.enc delete it, as it will install another key for you when following the instructions below.

For more context, you can go to this link.

Change the username and password within the config.database.yml to your own username and password as specified below.

username = {YOUR DATABASE USERNAME || postgres}
password = {YOUR DATABASE PASSWORD}

Create a Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

Run the seed folder.

rails db:seed

Usage

To run the project on the backend, execute the following command:

   rails s  # to run the server on default port 3000
   # to be able to access the database

To run the project on the frontend, execute the following command:

   npm run dev  # to run the server on default port 3000
   # to be able to access the database

(back to top)

👥 Authors (4 Micronauts)

👤 Keenan Botes

• GitHub: @keebot-png
• Twitter: @KeenanBotes
• LinkedIn: [email protected]

👤 Linus shaddai

• GitHub: @linushaddai99
• LinkedIn: @linusshaddai -Twitter: @ShaddaiLinus

👤 Kennedy Omondi

• GitHub: @kennankole
• Twitter: @obwombe_kennedy
• LinkedIn: LinkedIn

👤 onwuanibe Onomeh

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

(back to top)

🔭 Future Features

• Admin Roles and access to the latest courses
• Keep count of enrolled students to indicate popularity of the course

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code Reviewers

(back to top)

❓ FAQ

• How I can install rails?

  • You can follow the official guide to install rails. If you have gem installed, you can run gem install rails to install rails.

• How I can run tests?

  • After cloning the repository, run bundle and then run rspec to run the tests.

(back to top)

📝 License

This project is MIT licensed.

(back to top)