-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add info to the README.md and CONTRIBUTING.md files #4
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,49 @@ | ||
# FLorist | ||
|
||
TODO | ||
A platform to launch federated learning (FL) training jobs. | ||
|
||
## Setting up | ||
|
||
### Install dependencies | ||
|
||
To install the project dependencies, first you need to create a virtual environment. | ||
The easiest way is by using the [virtualenv](https://pypi.org/project/virtualenv/) package: | ||
|
||
```shell | ||
virtualenv venv | ||
source venv/bin/activate | ||
``` | ||
|
||
We use [Poetry](https://python-poetry.org/) to manage back-end dependencies: | ||
|
||
```shell | ||
pip install --upgrade pip poetry | ||
poetry install | ||
jewelltaylor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
|
||
We use [Yarn](https://yarnpkg.com/) to manage front-end dependencies. Install it on MacOS | ||
using [Homebrew](https://brew.sh/): | ||
|
||
```shell | ||
brew install yarn | ||
``` | ||
|
||
Then install the project dependencies: | ||
```shell | ||
yarn | ||
``` | ||
|
||
### Running the server | ||
|
||
Use Yarn to run both the back-end and front-end on server mode: | ||
|
||
```shell | ||
yarn dev | ||
``` | ||
|
||
The front-end will be available at `http://localhost:3000`. If you want to access | ||
back-end APIs individually, they will be available at `https://localhost:8000`. | ||
|
||
### Running the client | ||
|
||
Coming up. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we explicitly mention we expect python between 3.9 and 3.11? Or it is it enough to have it in the pyproject.toml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think having it in
pyproject.toml
is enough, we don't have a hard requirement on it ourselves. Besides, when we change it, it's gonna be one less thing for us to worry about.