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

doc: Readme for tbp-consumer-api #54

Open
Luisnadachi opened this issue Aug 11, 2024 · 2 comments
Open

doc: Readme for tbp-consumer-api #54

Luisnadachi opened this issue Aug 11, 2024 · 2 comments
Labels
api Working around the /api folder documentation Improvements or additions to documentation
Milestone
v0.2.0

Comments

@Luisnadachi
Copy link

Hi guys, I want to contribute in the project but I had a lot of trouble to build the api. I think the project need a README that describe how to build and up the project. The points I was by myself are:

  • Build the cargo of rust
  • Installing the scyllaDB
  • Build the keyspace of twitch

I thought about writing the installation but I got stuck on this error:

thread 'main' panicked at src/main.rs:30:84:
called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }
@Luisnadachi Luisnadachi added documentation Improvements or additions to documentation api Working around the /api folder labels Aug 11, 2024
@DanielHe4rt
Copy link
Contributor

I'll work on it today.

@DanielHe4rt
Copy link
Contributor

Or maybe tomorrow LUL

@DanielHe4rt DanielHe4rt added this to the v0.2.0 milestone Aug 15, 2024
@gvieira18 gvieira18 mentioned this issue Aug 21, 2024
Merged
DanielHe4rt pushed a commit to basementdevs/tbp-consumer-api that referenced this issue Aug 21, 2024
@gvieira18
dx: improve makefile, setup docker compose, and allow config for max …
8308050 
…workers (#6)

## Summary

This PR introduces improvements aimed at enhancing the developer
experience (DX):

- **Makefile**: Improved for better usability with clearer and more
understandable commands.
- **Docker Compose Setup**: Added to streamline the development
environment setup, though the database is not included directly in this
setup. Instead, the database configuration is managed by a separate
project [ws-scylla](https://github.com/gvieira18/ws-scylla).
- **Max Workers**: Introduced the ability to specify the maximum number
of workers. If `MAX_WORKERS` is not provided, it defaults to using all
available cores.
- **Additional Improvements**:
  - Added **EditorConfig** for consistent code formatting.
- Simplified versioning by removing `current_schema`, reducing the
annoyance of unnecessary updates every time `make migrate` is run.

> [!NOTE]
> A README about how to set up the system is pending and will be done
later. This could be expanded to cover other services as well.

- basementdevs/twitch-better-profile#54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api Working around the /api folder documentation Improvements or additions to documentation
Projects
Twitch Addon
Status: No status
Milestone
v0.2.0
Development

No branches or pull requests
2 participants
@DanielHe4rt @Luisnadachi