Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/ab-noori/eduplanner-backend
active-storage mvc-framework postgresql ruby-api ruby-app ruby-gem ruby-on-rails
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/ab-noori/eduplanner-backend
- Owner: ab-noori
- License: mit
- Created: 2023-09-28T14:11:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-29T14:58:57.000Z (10 months ago)
- Last Synced: 2024-05-17T15:46:35.825Z (8 months ago)
- Topics: active-storage, mvc-framework, postgresql, ruby-api, ruby-app, ruby-gem, ruby-on-rails
- Language: Ruby
- Homepage: https://edu-planner.onrender.com
- Size: 242 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> # EduPlanner Backend
| EduPlanner Schema ERD |
|---------------------------------------|
|
|
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [Link To The Frontend](#FrontEnd-link)
- [KanBan Board](#kanban-board)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [FAQ](#faq)
- [📝 License](#license)
**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](https://github.com/ab-noori/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](https://github.com/ab-noori/EduPlanner-Frontend)._
- Ruby
- Rails
- PostgreSQL
- **Store data for the EduPlanner website**
- **Provide API endpoints for data Entry**
- **Provide server-side validations**
## 🚀 Live Demo
[liveDemo](https://edu-planner.onrender.com/)
## KanBan Board
[KanBan Project link](https://github.com/users/ab-noori/projects/12)
[Initial Kanban Board state](https://user-images.githubusercontent.com/125574259/271379687-ac62e9d1-7816-497c-b31c-988240bd3eec.png)
**Our team was comprised of 3 developers @Aimable BANCUNGUYE, @Abdul Ali Noori, @gisa chris**
## 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
``````
👤 : **Gisa Chris**
- GitHub: [@gisa chris](https://github.com/gisachris)
- LinkedIn: [@gisa chris](https://linkedin.com/in/gisa-chris/)
👤 : **Abdulali noori**
- GitHub: [@Abdul Ali Noori](https://github.com/ab-noori)
- LinkedIn: [@Abdul Ali Noori](https://linkedin.com/in/abdulali-noori)
👤 : **Aimable BANCUNGUYE**
- GitHub: [@Aimable BANCUNGUYE](https://github.com/BANCUNGUYE66)
- LinkedIn: [@Aimable BANCUNGUYE](https://www.linkedin.com/in/aimable-bancunguye-aba703143/)
- **Google authentication**
- **More Class based features**
- **More Student based features**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ab-noori/EduPlanner-Backend/issues).
Please support this project, your contribution can make a significant difference.
Original design idea by [ Murat Korkmaz on Behance.](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)
- **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.
This project is [MIT](./LICENSE) licensed.