Rewrite readme with installation and requirements
Opened this issue · 5 comments
To give new contributers a better understanding of how to get started on the code, it would be nice if extra requirements and installation instructions are added to the readme file.
Note: we are accepting multiple pull requests to the readme file, since we feel it is important that the readme is as clear as can be to new users. If you think anything is missing or could use clarification, feel free to open a PR.
Requirements
Since the project is built in Laravel, requirements would be
- Laravel
- Composer
- NPM
But it is also necessary to have a mysql database up and running.
These requirements should be added including links to pages explaining how to install and use them.
Installation
Aditionally, the installation section needs to be checked to verify wheter all necessary steps to get the application up and running are included.
Can I contribute?
Can I contribute?
Hi @padmaja-22, yes of course! We will gladly receive any contributions in the form of pull-requests.
If you have any questions, do not hesitate to ask
So I need to add the links to the installations of requirements right?
Yes that would be nice. You can add a separate section "Requirements" above the "Installation" section in the readme
Cool