Project overview and installation instructions
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
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.
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.
- Front-end : Vue JS 3
- Back-end : Laravel 8
- Database : MySQL
In order to be fully funtional and uprunning the following should be followed
The following applications must be installed
- Xampp server with php version 8.0
- MySQL server
- Latest version of composer installed
- Node Package Manager(npm)
- Clone the repository
git clone https://github.com/salukadev/Pharmac-OMS.git
- Install Composer packages
composer install
- Install Node Package manager packages
npm install
- Add
.env
file and copy the content from.env.example
file - Configure the database in
.env
fileDB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE='Your database name' DB_USERNAME='Your database username' DB_PASSWORD='Your database password'
- Generate keys
php artisan key:generate
- Run development serve
php artisan optimize php artisan serve
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
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.
- Clone the project
git clone https://github.com/salukadev/Pharmac-OMS.git
- Create your Feature Branch
git checkout -b feature/AmazingFeature
- Commit your Changes
git commit -m 'Add some AmazingFeature'
- Push to the Branch
git push origin feature/AmazingFeature
- Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
This is a project done for the Information Technology project module of BSc.(Hons.) Degree in Information Technology in Sri Lanka Institute of Information Technology
- IT19188928 - Saluka Udbhasa - salukadev
- IT19142838 - Esala Senarathna - Esala-Senarathna
- IT19957180 - Danuja Wijerathne - danuja-wije
- IT19955896 - Salitha Tennakoon - salitha10
- IT19001708 - Parami Lelkada - pLe98
- IT19987880 - Manoj Rangana - RanganaPWM
- IT19987712 - Kavindya Perera - kavindya-perera
- IT19955896 - Ridma Reshan - ridma11