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

Create a README for the repository #132

Closed
jaczhi opened this issue Mar 12, 2024 · 0 comments · Fixed by #133 or #134
Closed

Create a README for the repository #132

jaczhi opened this issue Mar 12, 2024 · 0 comments · Fixed by #133 or #134
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jaczhi
Copy link
Collaborator

jaczhi commented Mar 12, 2024

Description

The readme should have things typical of a readme. It should have

  • Website link
  • Brief description
  • Links to wiki
  • Link to documentation https://ruralbrick.github.io/hagglehaul/
  • Describe how you invoke CI/CD script(s) to perform certain actions
  • How to run the project:
git clone blah blah
cd blah blah 
cd hagglehaul.client
npm install
cd ..
dotnet restore
dotnet build
dotnet run --no-build --launch-profile https

then visit https://localhost:5173/

@jaczhi jaczhi added the documentation Improvements or additions to documentation label Mar 12, 2024
@jaczhi jaczhi added this to the Sprint6 milestone Mar 12, 2024
This issue was closed.
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
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants