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.

Sign up for GitHub

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

Jump to bottom

docs: add setup instructions to README.md #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add setup instructions to README.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,33 @@ Some features are already implemented, and some others are still on the roadmap!
<!-- - Implements a full-mirror of hex, in case hex is down (because we can, so why not) -->
<!-- - Add a way to visualise a package directly -->

## Running Locally

### Requirements

To run the app locally you must have the following dependencies:

- [mise](https://mise.jdx.dev)
- [yarn](https://yarnpkg.com)
- [Docker](https://www.docker.comv)
- [dbmate](https://github.com/amacneil/dbmate)

Other dependencies (i.e. Gleam, Erlang, etc...) can be installed by running `mise install` in the root of the project.

### Setup Instructions

- Set the following environment variables:
- `HEX_API_KEY`
- `GITHUB_TOKEN`
- `PORT=3000`
- Setup the database by running the following commands:
- `cd ./apps/backend`
- `deno task db:init`
- `dbmate migrate`
- In the root of the project run:
- `yarn install`
- `yarn dev`

## Contributing

If Gloogle please you, you can also contribute! Pull Requests are welcome!
Expand Down