-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
578586f
commit a73ea8c
Showing
3 changed files
with
28 additions
and
46 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,20 +22,20 @@ | |
|
||
1. **Clone the repository** | ||
|
||
```bash | ||
```console | ||
git clone [email protected]:GenerateNU/sac.git | ||
``` | ||
|
||
2. **Install dependencies** | ||
|
||
```bash | ||
```console | ||
cd frontend/* | ||
yarn install | ||
``` | ||
|
||
- If you get an error about `expo-cli` not being installed, run `yarn global add expo-cli` and then run `yarn install` again. | ||
|
||
```bash | ||
```console | ||
cd server | ||
go get ./... | ||
``` | ||
|
@@ -46,7 +46,7 @@ | |
|
||
1. **Create client build** | ||
|
||
```bash | ||
```console | ||
cd frotend/sac-mobile | ||
eas login | ||
eas build:configure | ||
|
@@ -61,7 +61,7 @@ | |
|
||
3. **Start the client** | ||
|
||
```bash | ||
```console | ||
cd frontend/sac-mobile | ||
npx expo start --dev-client | ||
``` | ||
|
@@ -74,50 +74,50 @@ | |
|
||
- MacOS | ||
|
||
```bash | ||
```console | ||
brew services start postgresql@15 | ||
``` | ||
|
||
- Windows | ||
|
||
```bash | ||
```console | ||
pg_ctl -D /usr/local/var/postgres start | ||
``` | ||
|
||
2. **Create a user** | ||
|
||
```bash | ||
```console | ||
createdb | ||
``` | ||
|
||
3. **Create a database** | ||
|
||
```bash | ||
```console | ||
psql // opens psql shell | ||
CREATE DATABASE sac; | ||
``` | ||
|
||
4. **Create a user** | ||
|
||
```bash | ||
```console | ||
createuser postgres -U <your username> | ||
``` | ||
|
||
# Commands | ||
|
||
### React Native | ||
## React Native | ||
|
||
```bash | ||
```console | ||
npx expo start --dev-client // runnning dev client | ||
npx expo start --dev-client --ios // specific platform | ||
yarn format // format code | ||
yarn lint // lint code | ||
yarn test // run tests | ||
``` | ||
|
||
### Go | ||
## Go | ||
|
||
```bash | ||
```console | ||
go run main.go // run server | ||
go test ./... // run tests | ||
go fmt ./... // format code | ||
|
@@ -128,7 +128,7 @@ | |
|
||
To install use `./install.sh` and then run `sac-cli` to see all commands. | ||
|
||
```bash | ||
```console | ||
sac-cli migrate // run migrations | ||
sac-cli reset // reset database | ||
sac-cli swagger // generate swagger docs | ||
|
@@ -141,15 +141,15 @@ | |
|
||
1. **Create a new branch** | ||
|
||
```bash | ||
```console | ||
git checkout -b <branch-name> // this is determined by your ticket name | ||
``` | ||
|
||
2. **Make changes and commit changes:** | ||
|
||
- **Commit changes** | ||
|
||
```bash | ||
```console | ||
git add . | ||
git commit | ||
``` | ||
|
@@ -160,13 +160,13 @@ | |
|
||
3. **Push changes to GitHub** | ||
|
||
```bash | ||
```console | ||
git push | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
```console | ||
git push origin <branch-name> | ||
``` | ||
|
||
|
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