PlateMate is an application designed to empower restaurants using data-driven insights.
- Backend: Go, Fiber
- Frontend: React Native, TypeScript, Expo SDK 52
- Database: MongoDB Atlas
We use Nix as our devshell. It is very cool.
PLATEMATE DEVELOPMENT ENVIRONMENT
╭──────────────────┬─────────────────────────────────────────────────╮
│ scripts │ description │
├──────────────────┼─────────────────────────────────────────────────┤
│ backend-lint │ # Lints backend code. │
│ backend-run │ # Runs the backend server in development mode. │
│ backend-test │ # Tests backend code. │
│ database-script │ # Runs a script against the connected Database │
│ frontend-lint │ # Lints frontend code. │
│ frontend-run │ # Runs the frontend server in development mode. │
│ frontend-run-wsl │ # Runs the frontend server in tunnel mode. │
│ frontend-test │ # Runs the frontend tests. │
╰──────────────────┴─────────────────────────────────────────────────╯
(nix:devenv-shell-env) (devenv) ben@thinkpad:~/dev/platemate$
This guide assumes that you are using Linux/macOS. If you are using Windows, please install WSL.
To get started, clone the repository via HTTPS by running git clone https://github.com/GenerateNU/platemate.git.
If you'd prefer, you can clone it via SSH.
- Install Nix
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
- Type in computer password if prompted.
- Say yes to prompt.
- In a new terminal activate the development environment by running the following:
nix develop --impure- Ask a Tech Lead for help!
ATLAS_USER=
ATLAS_PASS=
ATLAS_CLUSTER=
ATLAS_ENVIRONMENT=
AWS_REGION=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_BUCKET_NAME=
SENDGRID_API_KEY=