Skip to content

fixing readme, added and got rid of some documentation #62

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

Merged
SethColeman50 merged 3 commits into from
Apr 24, 2025
Merged

fixing readme, added and got rid of some documentation #62

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2c2fa5
fixing readme, added and got rid of some documentation
CloudUki Apr 16, 2025
e9e3d3f
added back the pytest
CloudUki Apr 21, 2025
ede2ea0
fixing the pytest section
CloudUki Apr 21, 2025
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
30 changes: 6 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
### <ins>**How to Set up the Local Development Enviroment**<ins>
1. Download relevant repos:
```
git clone https://github.com/mirrulations/mirrulations-website.git
git clone https://github.com/mirrulations/API.git
```
- Clone the query functions in the API repo by running `git submodule update --init`
Expand All @@ -24,32 +23,14 @@ git clone https://github.com/mirrulations/API.git
- This will remake the symlink from docker to CLI
- We think this was caused by the fix to the docker malware issue earlier in the semester.

3. Install the prerequisites npm libraries
```
npm install dotenv vite
npm install react react-dom react-router-dom
npm install bootstrap
npm install -D @vitejs/plugin-react
```
4. Launch the API, navigate to the API repo and run the following commands
3. Launch the API, navigate to the API repo and run the following commands
```
sam build
sam local start-api
```
If you make changes to template.yaml, run sam validate to check for errors and sam build to implement the changes.

Take note of your api gateway link for later, you can see it in the output under “Mounting ApiFunction at {GATEWAY_URL_HERE} [GET, OPTIONS]”


5. Launch the Website
- Create a file named “.env”
- Type “VITE_GATEWAY_API_URL={GATEWAY_URL}”
- Your Gateway URL is the output from the last step, it might look something like “http://127.0.0.1:3000/dummy”
- Save the file and run this command
```
npm run dev
```

### How to Launch just the API
- If any changes have been made to `template.yaml`, run `sam validate` to check for errors.
- Make sure to install [Docker](https://www.docker.com/get-started/)
Expand Down Expand Up @@ -89,11 +70,12 @@ The `samconfig.toml` file stores configuration parameters for SAM CLI deployment

## Running Tests
- Make a python virtual environment.
- `python -m venv .venv`
- `source ./.venv/bin/activate`
- `pip install -r requirements.txt`
- `python -m venv .venv`
- `source ./.venv/bin/activate`
- `pip install -r requirements.txt`
- cd to endpoints specifically and run `python -m pytest ../tests/handler_test.py`
- I do not know why the tests don't work in other directories, here's a [stackoverflow link](https://stackoverflow.com/questions/45154583/pytest-running-from-parent-directory) that might have the answers.
- cd to the root specifically and run `pylint --rcfile=./tests/.pylintrc $(git ls-files '*.py')
Copy link
Contributor

@SethColeman50 SethColeman50 Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this runs linting and not the test, so I think both should stay in the readme

Copy link
Contributor Author

@CloudUki CloudUki Apr 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, I can also double check with @TeranG710

Copy link

@TeranG710 TeranG710 Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CloudUki Yes the command runs linting on every file ending in 'py' in the directory.

Copy link
Contributor Author

@CloudUki CloudUki Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TeranG710 gotcha, ill add it back in then thank you.

- Here's a [stackoverflow link](https://stackoverflow.com/questions/45154583/pytest-running-from-parent-directory) that might help you if you get stuck.

This README has been adapted to utilize the automated deployment features of AWS SAM, making it easier and faster to manage your deployments.

Expand Down
Loading