- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
StakeConnect API is an API designed access a school's entire activities.The database designed is based on this schema
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
Database
Describe between 1-3 key features of the application.
- Register student
- Parent access
- View activities update
Front-end Repo coming soon ...
To get a local copy up and running, follow these steps.
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]
Clone this repository to your desired folder:
cd my-folder
git clone git@github.com:principlebrothers/Stakeconnect.git
Install this project with:
cd Stakeconnect
bundle install
To run the project, execute the following command:
rails server
To run tests, run the following command:
bin/rails rspec spec
You can deploy this project using:
👤 Ernest Anyewe Adonu
- GitHub: @principlebrothers
- Twitter: @adonu_ernest
- LinkedIn: Ernest Anyewe Adonu
- API_Token
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page).
If you like this project, kindly give it a ⭐️
The design was provided by Pavithran. N on Behance.
-
Is Rails still relevant?
-
Is it easy to learn Ruby on Rails
This project is MIT licensed.