principlebrothers / stakeconnect

A school management mobile and web application that keeps track of student's attendance, and homework, and helps both parents and students obtain access to school-shared documents, attachments, and events.

Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 SCHOOL MANAGEMENT SYSTEM

StakeConnect API is an API designed access a school's entire activities.The database designed is based on this schema

🛠 Built With

Tech Stack

Ruby on Rails (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Register student
• Parent access
• View activities update

(back to top)

API-Documentain

• Link To Documentation coming soon ...

🚀 Live Demo

• Live Demo Link Coming soon...

Front-end Repository

Front-end Repo coming soon ...

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby
• Ruby and Rails on you operating system eg. for Ubuntu 20.04
• Node.js installed
• PostgreSQL database installed

Note: It is recommended you use the latest version of Ruby[3.2.1] and Rails[7.0]

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:principlebrothers/Stakeconnect.git

Install

Install this project with:

  cd Stakeconnect

  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails rspec spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Ernest Anyewe Adonu

• GitHub: @principlebrothers
• Twitter: @adonu_ernest
• LinkedIn: Ernest Anyewe Adonu

(back to top)

🔭 Future Features

• API_Token

(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, kindly give it a ⭐️

(back to top)

🙏 Acknowledgments

The design was provided by Pavithran. N on Behance.

(back to top)

❓ FAQ (OPTIONAL)

• Is Rails still relevant?

  • Yes, Rails is still popular among developer

• Is it easy to learn Ruby on Rails

  • It is very easy to learn compared to most of the programming languages

(back to top)

📝 License

This project is MIT licensed.

(back to top)