Skip to content

Commit d343da5

Browse files
added codespace setup script and misc changes
Signed-off-by: Daniel Miretsky <miretskyd@wit.edu>
1 parent 6adfbbe commit d343da5

1 file changed

Lines changed: 11 additions & 19 deletions

File tree

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Getting Started
22

3-
This guide will walk you through setting up the application for development.
3+
This guide will walk you through setting up the application for development using GitHub Codespaces.
44

5-
## Use GitHub Codespaces
5+
## Setup
66

77
1. Create a new branch OR fork this repository
88

@@ -21,20 +21,12 @@ This guide will walk you through setting up the application for development.
2121
bundle install
2222
```
2323

24-
6. **Set up environment variables:**
25-
26-
This project uses a `.env.example` file to define required environment variables. Copy it to `.env` and fill in the values for your local setup.
27-
28-
```bash
29-
cp .env.example .env
30-
```
31-
32-
7. **Set up Postgres server:**
24+
6. **Set up Codespace:**
3325

3426
Run the following command in the terminal:
3527

3628
```bash
37-
docker run -d --name calendar-postgres -p 5432:5432 postgres:16
29+
./bin/codespace-setup
3830
```
3931

4032
7. **Set up Rails credentials:**
@@ -45,11 +37,7 @@ This guide will walk you through setting up the application for development.
4537
* Email @jasper [mayonej@wit.edu] for the development key to decrypt the credentials.
4638
* Paste the key into `config/credentials/development.key`
4739

48-
The credentials file should include:
49-
- Google OAuth client ID and secret (for admin authentication)
50-
- Active Record encryption keys (for encrypting OAuth tokens)
51-
- Rate My Professor API credentials
52-
- Any other third-party service credentials
40+
**Note: You'll need to create the `development.key` file. Ensure it is created in the correct directory (`config/credentials`).**
5341
5442
8. **Create and seed the database:**
5543
@@ -65,9 +53,9 @@ This guide will walk you through setting up the application for development.
6553
bin/dev
6654
```
6755
68-
This will start the web server, the background job worker, and the CSS watcher. You can access the application at `http://127.0.0.1:3000`.
56+
This will start the web server, the background job worker, and the CSS watcher. You can access the application at `http://127.0.0.1:3000/users/sign_in`.
6957
70-
**Note:** Make sure you have the credentials master key file at `config/credentials/development.key` to access encrypted credentials for Google OAuth and other services.
58+
**Note:** Make sure you have the credentials master key file at `config/credentials/development.key` to access encrypted credentials for Google OAuth and other services (see step 7).
7159
7260
10. **Set up Google OAuth:**
7361
@@ -82,3 +70,7 @@ This guide will walk you through setting up the application for development.
8270
c. Right click the "Forwarded Address" for port 3000 and click "Copy Local Address" as shown below:
8371
<img width="1451" height="815" alt="image" src="https://github.com/user-attachments/assets/ad953767-609e-4e74-a8d8-583648f7b060" />
8472
73+
## Troubleshooting
74+
75+
If you run into any errors in the terminal you don't recogize, feel free to run them by @jasper [mayonej@wit.edu].
76+

0 commit comments

Comments
 (0)