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

Add install instruction to project's readme. #33

Open
itsMarcoSolis opened this issue Aug 28, 2023 · 0 comments
Open

Add install instruction to project's readme. #33

itsMarcoSolis opened this issue Aug 28, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@itsMarcoSolis
Copy link
Member

As a contributor
I need clear install instructions
So that I can easily bootstrap the project to develop on my local machine

Details and Assumptions

  • Standard NextJS installation
  • The only tricky part could be running the patch-package script, not sure if it's ran by default after installing modules.
  • Create .env file and add REACT_APP_THE_GRAPH_KEY

Acceptance Criteria

Given a new user/developer wants to install and run Otomee locally from source
When following the Installation instructions of the readme
Then after finishing the last step, running npm start should successfully run Otomee ready to use.
@itsMarcoSolis itsMarcoSolis added the documentation Improvements or additions to documentation label Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants