Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add README.md file #254

Merged
merged 18 commits into from
Aug 28, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fix typos
bitfalt committed Aug 28, 2024

Unverified

This user has not yet uploaded their public signing key.
commit 9819d85afea1e2114b0599a298a55581a9166407
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -30,15 +30,15 @@ docker --version
```
If you don't have Docker installed, please go to the [Docker installation page](https://docs.docker.com/get-started/get-docker/) for further instructions.

## Installaction Instructions
## Installation Instructions

Fork the repository and clone the forked repository to your local system

```bash
git clone https://github.com/<your-user>/api.starknet.quest.git
```

## Build instructions
## Build Instructions

To build the project use the following command in a terminal

@@ -54,7 +54,7 @@ If you wish to create an optimized binary without debug information run the foll
cargo build --release
```

## Running the project
## Running the Project

To run the project successfully you'll need to do the following steps:
1. Deploy `db-docker-compose.yml` file to use MongoDB database