https://github.com/vic778/school-management

this is a simple backedn project for class managment where teachers can CRUD a student and assign the test to them as well. studnt will be able to login thourht their credentials generated by the teachers. teacher only teachers can manager the CRUD of the whole app even update the user role to be a teacher.
https://github.com/vic778/school-management

postgresql pundit-matchers rspec rswag rubocop-rails ruby ruby-on-rails

Last synced: 4 months ago
JSON representation

this is a simple backedn project for class managment where teachers can CRUD a student and assign the test to them as well. studnt will be able to login thourht their credentials generated by the teachers. teacher only teachers can manager the CRUD of the whole app even update the user role to be a teacher.

• Host: GitHub
• URL: https://github.com/vic778/school-management
• Owner: vic778
• Created: 2022-11-18T14:01:38.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2022-11-22T17:28:50.000Z (over 2 years ago)
• Last Synced: 2025-01-18T16:16:32.339Z (5 months ago)
• Topics: postgresql, pundit-matchers, rspec, rswag, rubocop-rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 1.35 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SCHOOL_MANAGEMENT 

> This is a simple backedn project for class managment where teachers can CRUD a student and assign the test to them as well. studnt will be able to login thourht their credentials generated by the teachers. teacher only teachers can manager the CRUD of the whole app even update the user role to be a teacher. the app has a main teahcer who is by default createdt in the seed of the app. This API is made these models:

  - Role Model

  - User Model

  - Test Model

  - Question mondel 

  - Answer Model

  

### Video Demo

[VIDEO DEMO](https://www.loom.com/share/6139af6a6a384ab49421e0111e4b7d89)

  

### ERD PG

![img](app/assets/images/screen1.png)

### User confirmation Mailer

![img](app/assets/images/screen3.png)

### Message rendered from the backend 

![img](app/assets/images/screenshot2.png)

### Deployment

 N/A `Kinldy i can't config my google SMTP because i using it to some of my projects that's why i did;\'nt deployed the app on heroku as well`

## Built With

- Rails

- Ruby 

- Postgresql

- Devise

- JWT

- ActiveRecord Serializer

- Sidekiq

- Redis

- Rswag

## Getting Started

Here are the steps to follow in order to get this project on your local computer.

### Prerequisites

`rails v7.0.2 +`

`ruby v3.0.2 +`

### Setup

clone this repo by typing `git clone https://github.com/vic778/`

### Install

install the dependencies by typing `bundle install`

### Usage

start the local server by running `rails s`

### Testing

run the tests by typing `rails rswag`

![img](app/assets/images/rswag.png)

![img](app/assets/images/rspec.png)

### Documentation

## Author

👤 **Victor Barh**

- GitHub: [@Vvic778](https://github.com/vic778)

- Twitter: [@victoirBarh](https://twitter.com/)

- LinkedIn: [LinkedIn](https://linkedin.com/in/victoir-barh)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

 N/A

## 📝 License

This project is [MIT](lic.url) licensed.