Mathilda Management

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • ERD Diagram
  • API Documentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Mathilda Management

Mathilda Management is the technical assessment given to me by mathilda®.

=> Here is the mathilda management frontend repository

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Teachers and students are identified by their email addresses and remember them after login in cookies by using jwt.
• Each teacher can teach multiple subjects across multiple classes.
• A class can consists of 2 types of students, internal and external.
• External students’ details are retrieved from an external system.
• The external system will only update external student details at 12:00 am daily.

(back to top)

🚀 Live Demo

• Live version

ERD Diagram

(back to top)

API Documentation

• API Documentation

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby
• Rails
• PostgreSQL
• Code editor (VSCode)

Setup

Clone this repository to your desired folder:

  git clone https://github.com/K0ppai/mathilda-management

Install

Install this project run these commands in order:

  cd mathilda-management
  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Paing Soe Thu

• GitHub: @K0ppai
• Twitter: @koppai
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Implement delete features
• Add form validations

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, don't forget to give it a ⭐️. 😉

(back to top)

🙏 Acknowledgments

I would like to thank mathilda® for this amazing opportunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)