https://github.com/tanveerisonline/classup-final-capstoneproject
ClassUp is an online learning platform created as a capstone project at Microverse. It offers users the ability to book online classes and organize study sessions with other learners in their vicinity. By combining virtual learning with real-world interactions, ClassUp aims to create an engaging and collaborative learning atmosphere for students.
https://github.com/tanveerisonline/classup-final-capstoneproject
bootstrap5 eslint gitflow jest postgres react redux render rspec rswag ruby ruby-on-rails stylelint webpack5
Last synced: 2 months ago
JSON representation
ClassUp is an online learning platform created as a capstone project at Microverse. It offers users the ability to book online classes and organize study sessions with other learners in their vicinity. By combining virtual learning with real-world interactions, ClassUp aims to create an engaging and collaborative learning atmosphere for students.
- Host: GitHub
- URL: https://github.com/tanveerisonline/classup-final-capstoneproject
- Owner: tanveerisonline
- License: mit
- Created: 2023-06-02T20:00:03.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-30T13:13:37.000Z (over 1 year ago)
- Last Synced: 2025-01-21T04:32:04.772Z (4 months ago)
- Topics: bootstrap5, eslint, gitflow, jest, postgres, react, redux, render, rspec, rswag, ruby, ruby-on-rails, stylelint, webpack5
- Language: JavaScript
- Homepage: https://classup.onrender.com/
- Size: 3.65 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/IndieCoderMM/e-learning-academy/graphs/contributors)
[](https://github.com/IndieCoderMM/e-learning-academy/commits/main)
[](https://github.com/IndieCoderMM/e-learning-academy/stargazers)
[](https://github.com/IndieCoderMM/e-learning-academy/issues)
[](https://github.com/IndieCoderMM/e-learning-academy/blob/main/LICENSE)
Table of Contents
- [🎓 ClassUp - Online Learning Platform ](#-classup---online-learning-platform-)
- [📸 Screenshots ](#-screenshots-)
- [🚀 Live Demo](#-live-demo)
- [📋 Kanban Board](#-kanban-board)
- [🧰 Tech Stack ](#-tech-stack--)
- [✨ Key Features ](#-key-features--)
- [📘 Getting Started ](#-getting-started--)
- [📋 Prerequisites](#-prerequisites)
- [📂 Setup](#-setup)
- [📥 Installation](#-installation)
- [💾 Database](#-database)
- [💻 Usage](#-usage)
- [📃 API](#-api)
- [🧪 Tests](#-tests)
- [👨💻 Authors ](#-authors--)
- [🎯 Future Features ](#-future-features--)
- [🤝 Contribution ](#-contribution--)
- [💖 Show Your Support ](#-show-your-support--)
- [🙏 Acknowledgements](#-acknowledgements)
- [📜 License ](#-license-)
# 🎓 ClassUp - Online Learning Platform
**ClassUp** is a collaborative online learning platform developed as the final capstone project at Microverse.
Our website allows users to reserve online classes while also providing the opportunity to schedule study sessions with fellow learners in their area. By bridging the gap between virtual learning and real-world interactions, Classup creates a vibrant and collaborative learning environment for students of all backgrounds.
## 🚀 Live Demo
You can checkout the live demo of our project at [classup.onrender.com](https://classup.onrender.com/)
## 📋 Kanban Board
We used a Kanban board to manage our tasks and track the progress of our project.
This is [the link to our Kanban Board](https://github.com/users/IndieCoderMM/projects/4).
We're a group of 3 members: [@tobuya](https://github.com/tobuya), [@tanveerisonline](https://github.com/tanveerisonline), [@IndieCoderMM](https://github.com/indiecodermm)
- **Back-end** 💻:
- [Ruby on Rails](https://rubyonrails.org/) - Creating API endpoints and managing databases
- [PostgreSQL](https://www.postgresql.org/) - Database management system
- **Front-end** 🎨:
- [React](https://reactjs.org/) - Building user interfaces
- [Redux](https://redux.js.org/) - Managing states and API calls
- [Bootstrap](https://react-bootstrap.github.io/) - Pre-built UI components
- **Tools** 🛠:
- [Rspec](https://rspec.info/) - Testing models and requests
- [RSwag](https://github.com/rswag/rswag) - Documenting and testing API endpoints
- [Jest](https://jestjs.io/) - Unit tests for frontend components
- [Webpack](https://webpack.js.org/) - Module bundler for React/javascript
- [Render](https://render.com/) - Cloud platform for deployment
- Browse list of available courses
- Log in with a username and access all features
- Reserve online classes according to preferred time and location
- View upcoming classes and reservations
- Mobile-friendly and responsive design
To run this project locally, you'll need to follow these steps.
### 📋 Prerequisites
Make sure you have the following installed on your machine:
- [Ruby 3.1.3 or higher](https://www.ruby-lang.org/en/)
- [Rails 7.0.4 or higher](https://rubyonrails.org/)
- [PostgreSQL 15.2 or higher](https://www.postgresql.org/)
- [Node 18.14 or higher](https://nodejs.org/en)
### 📂 Setup
Clone this repository to your desired foler.
```sh
cd my-project
git clone [email protected]:IndieCoderMM/e-learning-academy.git .
```
### 📥 Installation
Install the required gems with:
```sh
bundle install
```
Install the node dependencies with:
```sh
npm install
```
### 💾 Database
Create the databases and run migrations with:
```sh
rails db:create
rails db:migrate
```
To load the sample data, run:
```sh
rails db:seed
```
### 💻 Usage
Build the frontend assets with:
```sh
npm run build
```
To run the development server, execute the following command:
```sh
rails server
```
*Once the server is up and running, you can access the website on `http://localhost:3000`*
### 📃 API
To read the API documentation, visit `https://localhost:3000/api-docs`
### 🧪 Tests
To run tests, run the following command:
```sh
rspec spec --format doc
```
To test the frontend components, run:
```sh
npm test
```
We worked collectively on both the frontend and backend development, dividing features among us to ensure a well-rounded and efficient system.
Feel free to reach out to us with your suggestions, ideas, or feedback. We are always eager to improve our website.
👤 **Thomas Obuya**
- GitHub: [@githubhandle](https://github.com/tobuya)
- Twitter: [@twitterhandle](https://twitter.com/MullerTheGreat1)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tobuya)
👤 **Tanveer Ahmad**
- GitHub: [@tanveerisonline](https://github.com/tanveerisonline)
- Twitter: [Tanveer Ahmad](https://twitter.com/Tanveer98589023)
- LinkedIn: [Tanveer Ahmad](https://www.linkedin.com/in/tanveer-ahmad-899462211/)
👤 **Hein Thant**
- GitHub: [@IndieCoderMM](https://github.com/indiecodermm)
- LinkedIn: [@hthantoo](https://linkedin.com/in/hthantoo)
- Gmail: [email protected]
- [ ] Implement secure *User authentication*
- [ ] Implement *Authorization* (Roles: Admin, Instructor, User)
- [ ] Add *Join-study-sessions Feature*
- [ ] Implement *Edit-courses Feature*
- [ ] Implement *Search Feature*
Contributions, issues, and feature requests are welcome!
If you like this project, please consider giving it a ⭐.
## 🙏 Acknowledgements
This app was designed based on an original design idea by [Murat Korkmaz](https://www.behance.net/muratk) on Behance.
We would like to thank Murat Korkmaz for this inspiring design.
- [App Design Template](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)
This project is [MIT](./LICENSE) licensed.