julirash / clearme

Clearance system for outgoing students.

ClearMe

Clearance management system for outgoing students.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should element DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Bootstrap
• JQuery
• Laravel

Getting Started

Setting up clearme is a pretty easy step.

Prerequisites

Clone the repository from GitHub

• PHP >= 7.4
• Composer

Installation

1. Clone the repo

   git clone https://github.com/GabrielFemi/clearme.git

2. Install Composer dependencies

   composer install

3. Run the database seeder

    php artisan db:seed

4. Run this script to create all necessary roles

    sh app/roles.sh

5. Serve the application (Run in your Terminal)

   php artisan serve

Usage

• Seed the application with roles

php artisan permission:create-role admin
php artisan permission:create-role student

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gabriel Akinyosoye - @humaneguy - [email protected]

Project Link: https://github.com/GabrielFemi/clearme

Acknowledgements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome