You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-19Lines changed: 11 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Getting Started
2
2
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.
4
4
5
-
## Use GitHub Codespaces
5
+
## Setup
6
6
7
7
1. Create a new branch OR fork this repository
8
8
@@ -21,20 +21,12 @@ This guide will walk you through setting up the application for development.
21
21
bundle install
22
22
```
23
23
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:**
33
25
34
26
Run the following commandin the terminal:
35
27
36
28
```bash
37
-
docker run -d --name calendar-postgres -p 5432:5432 postgres:16
29
+
./bin/codespace-setup
38
30
```
39
31
40
32
7. **Set up Rails credentials:**
@@ -45,11 +37,7 @@ This guide will walk you through setting up the application for development.
45
37
* Email @jasper [mayonej@wit.edu] for the development key to decrypt the credentials.
46
38
* Paste the key into `config/credentials/development.key`
47
39
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`).**
53
41
54
42
8. **Create and seed the database:**
55
43
@@ -65,9 +53,9 @@ This guide will walk you through setting up the application for development.
65
53
bin/dev
66
54
```
67
55
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`.
69
57
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).
71
59
72
60
10. **Set up Google OAuth:**
73
61
@@ -82,3 +70,7 @@ This guide will walk you through setting up the application for development.
82
70
c. Right click the "Forwarded Address" for port 3000 and click "Copy Local Address" as shown below:
0 commit comments