Skip to content

Add install instruction to project's readme. #33

@itsMarcoSolis

Description

@itsMarcoSolis

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions