Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added badges for code coverage, code style and unit tests
  • Loading branch information
kashishvjain authored Dec 15, 2023
1 parent 286e8a8 commit 1a39e66
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![codecov](https://codecov.io/gh/CSE-210-Team-6/shuttlecraft/graph/badge.svg?token=01369M4P5C)](https://codecov.io/gh/CSE-210-Team-6/shuttlecraft)
![code style](https://github.com/CSE-210-Team-6/shuttlecraft/actions/workflows/lint.yml/badge.svg)
![tests](https://github.com/CSE-210-Team-6/shuttlecraft/actions/workflows/test.yml/badge.svg)

# SHUTTLECRAFT by the Confused Mavericks

This is a project to create an "easy" way to participate in the ActivityPub "Fediverse" and other indie web protocols like RSS.
Expand Down Expand Up @@ -141,8 +145,8 @@ WHOA! What happened? Well, a copy of the Shuttlecraft code was sent to a new, un

1. First, make sure the URL of your Glitch project is the one you like. You can change it in the "Settings" menu.
2. Then, configure the options [as described above](#config) using the .env editor.
3. Finally, create and login to the dashboard at `https://yourdomain.glitch.me/private`.
4. It is very important that the domain you add while creating you user is `https://{yourdomain}.glitch.me`. If not this will break things!
3. Finally, create and login to the dashboard at `https://{yourdomain}.glitch.me/private`.
4. It is very important that the domain you add while creating you user is `https://{yourdomain}.glitch.me` and matches exactly with the one in .env file. If not this will break things!
5. Done!

### Advanced: Docker
Expand All @@ -163,6 +167,7 @@ WHOA! What happened? Well, a copy of the Shuttlecraft code was sent to a new, un
5. Deploy the image to your container platform with the required environment variables (`DOMAIN`).
6. Configure a web service to proxy requests to the container port and provide HTTPS (see "Reverse proxy" above).


## Customize

This app uses HandlebarsJS for templating.
Expand Down

0 comments on commit 1a39e66

Please sign in to comment.