https://github.com/bootstrap-academy/challenges-ms

The official challenges microservice of Bootstrap Academy - Learn Computer Science Online
https://github.com/bootstrap-academy/challenges-ms

academy bootstrap-academy hacktoberfest rust

Last synced: about 2 months ago
JSON representation

The official challenges microservice of Bootstrap Academy - Learn Computer Science Online

• Host: GitHub
• URL: https://github.com/bootstrap-academy/challenges-ms
• Owner: Bootstrap-Academy
• License: other
• Created: 2023-03-17T00:16:15.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-27T01:18:31.000Z (2 months ago)
• Last Synced: 2024-10-27T02:25:49.274Z (2 months ago)
• Topics: academy, bootstrap-academy, hacktoberfest, rust
• Language: Rust
• Homepage: https://bootstrap.academy
• Size: 1.04 MB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![check](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/check.yml/badge.svg)](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/check.yml)

[![test](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/test.yml/badge.svg)](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/test.yml)

[![build](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/build.yml/badge.svg)](https://github.com/Bootstrap-Academy/challenges-ms/actions/workflows/build.yml) 

![Version](https://img.shields.io/github/v/tag/Bootstrap-Academy/challenges-ms?include_prereleases&label=version)

[![dependency status](https://deps.rs/repo/github/Bootstrap-Academy/challenges-ms/status.svg)](https://deps.rs/repo/github/Bootstrap-Academy/challenges-ms)

# Bootstrap Academy Challenges Microservice

The official challenges microservice of [Bootstrap Academy](https://bootstrap.academy/).

If you would like to submit a bug report or feature request, or are looking for general information about the project or the publicly available instances, please refer to the [Bootstrap-Academy repository](https://github.com/Bootstrap-Academy/Bootstrap-Academy).

## Development Setup

1. Install the [Rust](https://www.rust-lang.org/) stable toolchain.

2. Clone this repository and `cd` into it.

3. Install [Just](https://github.com/casey/just) (`cargo install just`) and [Sea-ORM](https://www.sea-ql.org/SeaORM/) (`cargo install sea-orm-cli`)

4. Start a [PostgreSQL](https://www.postgresql.org/) database, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):

    ```bash

    podman run -d --rm \

        --name postgres \

        -p 127.0.0.1:5432:5432 \

        -e POSTGRES_HOST_AUTH_METHOD=trust \

        postgres:alpine

    ```

5. Create the `academy-challenges` database:

    ```bash

    podman exec postgres \

        psql -U postgres \

        -c 'create database "academy-challenges"'

    ```

6. Start a [Redis](https://redis.io/) instance, for example using [Docker](https://www.docker.com/) or [Podman](https://podman.io/):

    ```bash

    podman run -d --rm \

        --name redis \

        -p 127.0.0.1:6379:6379 \

        redis:alpine

    ```

7. Run `just migrate` to run the database migrations.

8. Run `just run` to start the microservice. You can find the automatically generated swagger documentation on http://localhost:8005/docs.