https://github.com/jackbisceglia/apptrack

track internships from pitt-csc repo
https://github.com/jackbisceglia/apptrack

Last synced: 3 months ago
JSON representation

track internships from pitt-csc repo

• Host: GitHub
• URL: https://github.com/jackbisceglia/apptrack
• Owner: jackbisceglia
• License: gpl-3.0
• Created: 2022-06-18T03:38:14.000Z (over 2 years ago)
• Default Branch: prod
• Last Pushed: 2024-05-02T04:00:23.000Z (9 months ago)
• Last Synced: 2024-10-08T13:35:45.324Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 10.3 MB
• Stars: 17
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [AppTrack](https://apptrack.tech)

##

AppTrack is retired. Things broke with domain/lambdas after ~1 year, and never got around to fixing this. [https://simplify.jobs/](https://simplify.jobs/) seems to be doing good things around this same area, and is partnered with PittCSC

 

**Directory Structure (city: service)**

- `sf/` → Golang REST API

- `montreal/` → AWS Lambda

- `tokyo/` → React/Typescript Web App 

- `istanbul` → Database Read Script (JS)

## Setup

### Go API `./sf`

- Make sure to have Go installed: [Golang Website](https://go.dev/learn/) (Version 1.16+)

- Navigate to `sf` directory: `cd sf`

- Put .env file in here (be sure to be in `/sf`) (*.env file posted in slack*)

- Run `go install github.com/cosmtrek/air@latest` to install [air](https://github.com/cosmtrek/air) (Go dev. server)

- Run `go mod tidy`

- Run `air` to spin up development server

  - Note: if this doesn't work, there are 2 options:

   - Look up error on Stack Overflow to try to fix so that dev server can run

   - Just run `go run main.go`, which will execute and run our Go server, but doesn't have hot reload. If you're not working on the API, this should be sufficient since hot reload won't be very important

- Server should be running at https://localhost:8080/

### Frontend `./tokyo`

- Navigate to `tokyo` directory: `cd tokyo`

- Run `npm install` to install dependencies

- Get the following extensions:

  - TailwindCSS Intellisense 

  - PostCSS Language Support

  - (TypeScript support too maybe?)

- Run `npm run dev` to boot dev server

- App should be running at https://localhost:3000

### Lambda `./montreal`

- `lambda_handler` is the entry point for the lambda (event and context don't matter for our purposes)

- Copy the .env file into the montreal directory from slack

- To test

  - run `cd montreal` to enter the directory

  - add `lambda_handler()` to the bottom of the file

  - run `python3 lambda_function.py`

- To add dependencies

  - run `cd montreal` to enter the directory

  - run `pip install `

    - ex. `pip install requests`

  - run `pip install --target ./package `

  - run `cd package`

  - run `zip -r ../my-deployment-package.zip .`

  - When the code is pushed and auto-deployed, the zip file will be used by AWS

- When pushed to main, our github action will take care of auto deploying the new code to AWS

  - It has its own credentials and everything, so there should be no need to visit AWS

  - [This is the guide](https://awstip.com/deploy-code-automatically-to-aws-lambda-using-github-actions-with-aws-cli-commands-2dfc6f1b84c8) I roughly followed to automate the deployment

  - If you need to check something on AWS or have questions about the lambda, contact me

    - slack: @nabil

    - email: [email protected]