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

Minor README Updates for Installation #1062

Merged
merged 16 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 1 addition & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Github Issue Number Here: <YOUR_GITHUB_ISSUE_NUMBER_HERE (include the hashtag)>
**What solution does this PR provide?**

**Testing Methodology**
> How did you test your changes and verify that existing
> functionality is not broken
> How did you test your changes and verify that existing functionality is not broken

**Any other considerations**
Binary file added .github/readme_images/backend_start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme_images/frontend_start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

Web Application where people new to Machine Learning can input a dataset and experiment around with basic Pytorch modules through a drag and drop interface

> **Deployed website:** https://datasciencegt-dlp.com/ </br> > **GitHub repo:** https://github.com/DSGT-DLP/Deep-Learning-Playground
> **Deployed website:** https://datasciencegt-dlp.com </br> **GitHub repo:** https://github.com/DSGT-DLP/Deep-Learning-Playground

# Getting Started

### Prerequisites

Have the following installed first:

1. [Node.js v18 via NVM](https://github.com/nvm-sh/nvm#installing-and-updating) (Install nvm first, and then install node & npm using nvm)
1. [Yarn 1.x](https://classic.yarnpkg.com/lang/en/docs/install) (Must be installed after npm. May upgrade to Yarn Modern in the future, keep an eye out for that!)
1. [Node.js v20 via NVM](https://github.com/nvm-sh/nvm#installing-and-updating) (Install nvm first, and then install node & npm using nvm)
1. [Mamba](https://github.com/conda-forge/miniforge#miniforge) (Make sure to install using the Miniforge distribution. On windows, remember to check the box that says that it will add mamba to path)
1. [pip](https://pip.pypa.io/en/stable/installation/) (Is also automatically installed with Python via Python's installer, make sure this version of pip is installed globally)
1. [dlp-cli](https://github.com/DSGT-DLP/dlp-cli#readme) (We have our own cli!)
Expand All @@ -21,12 +20,13 @@ Have the following installed first:

### Recommended

1. [GitKraken](https://help.gitkraken.com/gitkraken-client/how-to-install/) for helping with Git commands, especially if you're new to Git
1. [Postman](https://www.postman.com/downloads/) (Extremely helpful for testing REST APIs)
1. [Chrome](https://www.google.com/chrome/) (For Chrome developer tools)
1. [Redux Devtools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) (Helpful for debugging any Redux)
1. [Docker](https://www.docker.com/)
1. [go](https://go.dev/doc/install) (In case if you ever need to contribute to the dlp-cli)
1. [GitHub Student Developer Pack](https://education.github.com/pack) - Get GitHub Pro features and GitHub Copilot access for free
1. [GitKraken](https://help.gitkraken.com/gitkraken-client/how-to-install/) - for helping with Git commands, especially if you're new to Git
1. [Postman](https://www.postman.com/downloads/) - Extremely helpful for testing REST APIs
1. [Chrome](https://www.google.com/chrome/) - For Chrome developer tools
1. [Redux Devtools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) - Helpful for debugging any Redux
1. [Docker](https://www.docker.com/) - For Docker images
1. [go](https://go.dev/doc/install) - In case if you ever need to contribute to the dlp-cli
1. VSCode Extensions:
1. [Github Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
1. [IntelliCode](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode)
Expand All @@ -37,13 +37,20 @@ Have the following installed first:
1. [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker)
1. [Go](https://marketplace.visualstudio.com/items?itemName=golang.Go)

## Clone the Repository
## 1. Clone the Repository

`git clone https://github.com/DSGT-DLP/Deep-Learning-Playground.git` in the directory of your choice. If this installation is for the beginner project, do `git clone https://github.com/DSGT-DLP/dlp-practice.git`.
If you want the **main** project, run in the directory of your choice:
```sh
git clone https://github.com/DSGT-DLP/Deep-Learning-Playground.git
```

If this installation is for the **beginner project**, instead do:
```sh
git clone https://github.com/DSGT-DLP/dlp-practice.git
```

This can also be achieved through GitKraken.

## Frontend and Backend Package Installation
## 2. Frontend and Backend Package Installation

Run the following commands in the project directory (the root folder created after cloning):

Expand All @@ -52,7 +59,7 @@ Run the following commands in the project directory (the root folder created aft
| Install/Update Frontend Packages | `dlp-cli frontend install` |
| Install/Update Backend Packages | `dlp-cli backend install` |

## GitGuardian Pre-commit Check
## 3. GitGuardian Pre-commit Check

To install the GitGuardian cli and pre-commit, run

Expand All @@ -75,13 +82,13 @@ ggshield auth login

If this command works properly, you will be redirected to an auth route in the Git Guardian website. **Sign in using your Github account**. Then, you should be all set!

## Additional VSCode Setup (Recommended)
### Additional VSCode Setup (Recommended)

Access the VSCode command palette via `Ctrl+Shift+P`. Press `Python: Select Interpreter`. You need the Python VSCode extension for this.

Select the Python Interpreter named `dlp`.

## To start on localhost:
## 4. To start on localhost

Run the following commands in the project directory (the root folder created after cloning):

Expand All @@ -90,9 +97,12 @@ Run the following commands in the project directory (the root folder created aft
| Running the Frontend | `dlp-cli frontend start` |
| Running the Backend | `dlp-cli backend start` |

Make sure to run the above two commands in separate terminals.
Make sure to run the above two commands in separate terminals. You should see these Terminal messages and be able to go to these URLs on success:

![](.github/readme_images/frontend_start.png)
![](.github/readme_images/backend_start.png)

## AWS Setup
## 5. AWS Setup
If you will be working on tasks that interface with AWS resources/services, please follow the below steps (please install AWS CLI using this [link](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) first):

1. Request an AWS Account for Deep Learning Playground by messaging Faris, Karthik, or Daniel in the DLP Discord. Please include your Github username along with your personal email account
Expand All @@ -112,7 +122,7 @@ If you will be working on tasks that interface with AWS resources/services, plea
1. Run `cat ~/.aws/config` to look for the sso profile configured.
1. Run `export AWS_PROFILE=<sso_profile_name from step 6>`

Please message in the DLP Discord if you have any difficulty/issue with these steps.
Please message in the DLP Discord or view the [Bug Manual page](https://github.com/DSGT-DLP/Deep-Learning-Playground/wiki/Bug-Manual) if you have any difficulty/issue with these steps.

# Architecture

Expand Down
2 changes: 1 addition & 1 deletion dlp-cli
1 change: 0 additions & 1 deletion frontend/src/common/redux/userLogin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import { auth } from "@/common/utils/firebase";
import { FirebaseError } from "firebase/app";
import storage from "local-storage-fallback";
import { backendApi } from "./backendApi";
import { isNameValid } from "../utils/nameFormat";

export interface UserState {
user?: UserType | "pending";
Expand Down
Loading
Loading