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.

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

rename 'matchbook-types' to 'matchbook-messages' #20

Open
wbjohnston opened this issue Feb 18, 2021 · 3 comments · May be fixed by #39
Open

rename 'matchbook-types' to 'matchbook-messages' #20

wbjohnston opened this issue Feb 18, 2021 · 3 comments · May be fixed by #39
Assignees
Labels
C-maintenance Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Experience needed to fix: Easy / not much good first issue Good for newcomers M-matchbook-types Module: matchbook-types

Comments

@wbjohnston
Copy link
Owner

the package 'matchbook-types' is meant to hold type definitions for messages that will be passed on the UDP backbone. 'matchbook-messages' is more descriptive to the packages purpose.

@wbjohnston wbjohnston added enhancement M-matchbook-types Module: matchbook-types good first issue Good for newcomers labels Feb 18, 2021
@96RadhikaJadhav
Copy link

@wbjohnston Can I work on the issue?

@wbjohnston
Copy link
Owner Author

@96RadhikaJadhav Sure! I'm not sure how you find this repo, but go for it. I haven't really built a README out that tells you how to develop. Here are some basic instructions in the meantime

This project is a monorepo that contains multiple services. Each service is meant to be deployed as a separate process/server. All services are contained in the services/ directory.

In addition to the services there are shared packages. These are shared packages between services. matchbook-types is a package so it can be found under packages/matchbook-types

in order to build the project you'll need to have Rust, Docker, and Docker Compose

you can build the project using docker-compose build.
You can start the project using docker-compose up
You can do both at the same time using docker-compose up --build

Let me know if you have any questions. To be honest I really wasn't expecting anyone to look at this so I haven't taken any time on the documentation. But I'll prioritize that a bit more heavily :)

@wbjohnston
Copy link
Owner Author

@96RadhikaJadhav Are you still interested in resolving this issue?

@96RadhikaJadhav 96RadhikaJadhav linked a pull request Feb 21, 2021 that will close this issue
@wbjohnston wbjohnston linked a pull request Mar 17, 2021 that will close this issue
@wbjohnston wbjohnston added E-easy Call for participation: Experience needed to fix: Easy / not much C-maintenance Category: PRs that clean code up or issues documenting cleanup. labels Mar 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-maintenance Category: PRs that clean code up or issues documenting cleanup. E-easy Call for participation: Experience needed to fix: Easy / not much good first issue Good for newcomers M-matchbook-types Module: matchbook-types
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants