Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incomplete documentation on README #8

Open
MzeeAlii opened this issue Feb 22, 2022 · 0 comments
Open

Incomplete documentation on README #8

MzeeAlii opened this issue Feb 22, 2022 · 0 comments

Comments

@MzeeAlii
Copy link

As a frontend developer, my experience with backend development might a be a little short. So any instruction on the steps to get the code up and running is very helpful. It seems, the instructions provided are a little too brief for some (including myself).

For example, it is mentioned that someone has to "Create file .env then copy variables in sample.env" but the sample.env is nowhere near to be found and also no instructions on where to look for it. 😐

Also, it is said that "You need to provide Postgresql environment in enviroment file .env" This implies there are several steps necessary for the command (run command) to work successfully. Not sure which exactly those steps (prerequisites) are, maybe a specific database server installation, maybe a database has to be created and specified (as it is done in Laravel), maybe something entirely different from those. All that leaves me - with my tiny frontend development brain - wondering what to do and where to begin.

Thanks for the amazing effort you have put on this project, a bit more elaborated documentation will be much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant