ab-noori / EduPlanner-Backend

This is the Backend Api for the EduPlanner web application project. A rails based backend solution to storing class and student data from the EduPlanner web application.

EduPlanner Backend

EduPlanner Schema ERD

📗 Table of Contents

• 📖 About the Project
  • Link To The Frontend
  • KanBan Board
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• FAQ
• 📝 License

📖 EduPlanner-Backend

EduPlanner-Backend: This is the Backend API for the EduPlanner web application project. A rails-based backend solution to storing class and student data from the EduPlanner web application.

🔗 Frontend Link

Our EduPlanner-Frontend code is built using React and Redux and is hosted on a separate repository. The front end handles the user interface and integrates with my backend API to retrieve and display data. To access our frontend code, please click here.

🛠 Built With

• Ruby
• Rails
• PostgreSQL

Key Features

• Store data for the EduPlanner website
• Provide API endpoints for data Entry
• Provide server-side validations

(back to top)

🚀 Live Demo

liveDemo

(back to top)

KanBan Board

KanBan Project link

Initial Kanban Board state

Our team was comprised of 3 developers @Aimable BANCUNGUYE, @Abdul Ali Noori, @gisa chris

(back to top)

Getting Started

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

Prerequisites

To run this project you need:

• A basic understanding of Ruby, Rails, and Git
• A Postgresql connection
• Create some data before running to see Greatings

Usage

1. Install Ruby
2. Install Rails
3. Clone this repo

git clone https://github.com/ab-noori/EduPlanner-Backend.git

To run the project, execute the following command:

  rails server

To add some greetings to your application run the following commands

rails db:drop
rails db:create
rails db:migrate
rails db:seed

(back to top)

👥 Author

👤 : Gisa Chris

• GitHub: @gisa chris
• LinkedIn: @gisa chris

👤 : Abdulali noori

• GitHub: @Abdul Ali Noori
• LinkedIn: @Abdul Ali Noori

👤 : Aimable BANCUNGUYE

• GitHub: @Aimable BANCUNGUYE
• LinkedIn: @Aimable BANCUNGUYE

(back to top)

🔭 Future Features

• Google authentication
• More Class based features
• More Student based features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please support this project, your contribution can make a significant difference.

(back to top)

🙏 Acknowledgments

Original design idea by Murat Korkmaz on Behance.

(back to top)

FAQ

• Can I use this repository?

Please feel free to fork this repository for your own projects.

• Will my changes be accepted?

We welcome any improvements if your changes are good and align with the project's goals.

(back to top)

📝 License

This project is MIT licensed.

(back to top)