Lincoln University API

A Ruby on Rails API backend for the front-facing Flutter Mobile app and React JS desktop app

What it does

It serves as the backend for the Flutter and React JS apps, providing CRUD functionality for both

Tests Written With

• RSpec
• Shoulda Matchers
• Faker
• Database Cleaner
• Factory Bot Rails

Docs

• Models
• Auth
• Controllers
• API Endpoints

Live Demo

[Live Demo]()

Getting Started

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

• Clone the project unto your local machine
• cd into the project directory
• Run bundle install
• Run rails db:setup
• Run rails s
• Open up localhost:3000 in your browser to view the project

🤝 Contributing

Contributions, issues and feature requests are welcome! Start by:

• Forking the project
• Cloning the project to your local machine
• cd into the project directory
• Run git checkout -b your-branch-name
• Make your contributions
• Push your branch up to your forked repository
• Open a Pull Request with a detailed description to the development branch of the original project for a review

Pending and proposed features

• Rideshare - a rideshare solution for finding rides to different off-campus locations and stores.
• Student Forum - chat area for students.
• Bus Schedule - a bus schedule for the shuttle services.
• Meal Schedule - a meal schedule for on-campus dining.
• Physical Plant requests

Please feel free to contribute to any of these!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MiT licensed.

Built By Oluwadamilare Olusakin Check out my stories on medium to see what I'm talking about! Follow me on Instagram and Twitter to see what I am up to!

Enjoy!