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
Heya there, this is ACM Teach LA's website! It's goal is to give Teach LA a more formal online presence, and to create a one-stop shop for prospective tutors and schools to get more information about us!
8
9
9
-
This website is built with [Jekyll](https://jekyllrb.com), with some component implementations taken from [ACM's main website](https://github.com/uclaacm/website) (conforming to [ACM Design's Style Guide](https://github.com/uclaacm/Styleguide)). We build and test this website with [GitHub Actions](https://github.com/features/actions), and deploy it on [Netlify](https://www.netlify.com/). We will be running on ruby 3.2.5 and jekyll 4.3.3
10
+
This website is built with [Jekyll](https://jekyllrb.com), with some component implementations taken from [ACM's main website](https://github.com/uclaacm/website) (conforming to [ACM Design's Style Guide](https://github.com/uclaacm/Styleguide)). We build and test this website with [GitHub Actions](https://github.com/features/actions), and deploy it on [Netlify](https://www.netlify.com/). We will be running on ruby 3.2.5 and jekyll 4.3.3. You will find detailed installation and setup instructions below for both macOS and Windows.
10
11
11
-
## Development Setup
12
+
## 🍎 macOS Setup Instructions
12
13
13
14
To get a copy of this website running locally on your machine, you'll need [Ruby](https://www.ruby-lang.org/en/), a copy of this repo, and access to your system's shell/terminal.
14
15
15
-
*Note:* we recommend using [rvm](https://rvm.io/) instead of your system ruby; it makes life easier :smile:!
16
+
**We recommend using [`rbenv`](https://github.com/rbenv/rbenv) to manage Ruby versions.**
16
17
17
-
First, let's install [Bundler](https://bundler.io/), a gem environment manager for ruby. Type this anywhere in your shell:
18
+
### Ruby & Bundler Installation (If Ruby 3.2.5 is not yet installed)
Your site will be served locally at: [http://localhost:4000](http://localhost:4000). You may also visit the server address line in your browser, which is usually [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
69
+
70
+
71
+
If you run into any issues, you may also try:
72
+
73
+
```bash
74
+
bundle exec jekyll clean
75
+
bundle update
76
+
bundle exec jekyll serve
49
77
50
78
```
51
79
80
+
## 💻 Windows Setup Instructions (via RubyInstaller)
52
81
53
-
If these steps do not work for you, you may also try doing this:
82
+
If you're on **Windows**, follow these instructions instead of the macOS setup above:
54
83
84
+
### 1. Install Ruby (with DevKit)
55
85
56
-
Visit whatever follows the server address line in your browser, which is usually [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
Your site will be served locally at: [http://localhost:4000](http://localhost:4000). You may also visit the server address line in your browser, which is usually [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
122
+
123
+
### ✅ Notes for Windows users
124
+
125
+
- You may see build errors if native extensions fail to compile — make sure the DevKit is properly installed.
126
+
- Consider using [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/) for a smoother Unix-like development experience.
127
+
- Use `chcp 65001` to set terminal to UTF-8 encoding if you run into encoding issues.
128
+
---
59
129
60
130
## Contribution Workflow
61
131
@@ -69,30 +139,39 @@ Want to make a change to the website? Great! Here are the steps:
69
139
6. Make a [pull request](https://github.com/uclaacm/teach-la-website/pulls) with your changes, and let someone on the dev team know.
70
140
7. If your code passes code review, we'll merge it into `master`. Congratulations! If you'd like, it's now safe to delete your branch/fork.
71
141
142
+
---
143
+
72
144
## Adding Yourself to the Teams Page
73
145
74
-
[Moved to here](https://github.com/uclaacm/teach-la-website/blob/master/_team/README.md).
146
+
[Moved to here](https://github.com/uclaacm/teach-la-website/blob/master/_team/README.md)
75
147
76
-
## Troubleshooting tips:
77
-
1. run gem install bundler
78
-
- if doesnt work try to sudo
79
-
2. install homebrew. This way we can manage ruby version conflicts
80
-
3. run ruby -v. You want to be on version 3.2.5 (REALLY IMPORTANT)
81
-
4. run
148
+
## Troubleshooting Tips
82
149
83
-
```bash
150
+
1. Make sure you're using **Ruby 3.2.5**. Run:
84
151
85
-
brew install rbenv
86
-
brew install ruby-build
87
-
rbenv init
88
-
rbenv install 3.2.5
89
-
rbenv global 3.2.4
90
-
gem update jekyll
91
-
gem update bundler
92
-
bundle install
93
-
bundle update
152
+
```bash
153
+
ruby -v
154
+
```
94
155
95
-
```
156
+
If not, follow the Ruby installation instructions above.
157
+
158
+
2. If `bundle install` fails, try updating your gems:
159
+
160
+
```bash
161
+
gem update --system
162
+
gem update bundler
163
+
```
164
+
165
+
3. If `jekyll serve` crashes, clean and retry:
166
+
167
+
```bash
168
+
bundle exec jekyll clean
169
+
bundle exec jekyll serve
170
+
```
171
+
172
+
4. If you get file write errors like `Errno::EINTR`, try moving the repo to a non-synced folder (e.g. not inside iCloud Drive or Desktop).
173
+
174
+
175
+
If you run into any issues, please let us know on our [issues tracker](https://github.com/uclaacm/teach-la-website)!
96
176
97
-
** note: may need to sudo if you do not have permission
0 commit comments