bobluppes / bobluppes/barhive

Rewrite readme with installation and requirements

Open
#2 5 comments 1 reaction 0 assignees View on GitHub
good first issue hacktoberfest help wanted
Dominant language
Blade
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.