The ACM & ACM-W site uses hugo-academic. To get started, you'll want to clone the repo, using either:
1. git clone git@github.com:ucfacmw/ucfacmw.org (recommended)
- (a) Once you've cloned, make sure you run
git submodule update --init --recursivefrom the root directory of the repository.
2. GitHub Desktop (only on MacOS and Windows)
A note about (1): You'll see that there's a : between github.com and ucfacmw – this enforces the use of an SSH key. If you don't know what that is, or don't have one setup for GitHub – they have a dope guide.
This will walk you through adding an SSH key to your personal GitHub account. We recommend using -t ecdsa -b 384, but their options of -t rsa -b 4096 is also a good choice. Also, it's a good idea to set a password when prompted, but not entirely necessary.
A note about (2): This creates an SSH key for you (we believe), but we'd strongly recommend using option (1).
Once you have everything listed above, you'll want (1) Docker and (2) docker-compose.
Using a Terminal (recommended):
- MacOS: Use brew. Then run
brew install dockerandbrew install docker-compose. - Linux: Use your OS's package manager.
- Windows: Use chocolatey. Then run
choco install dockerandchoco install docker-compose
GUI Installers (MacOS / Windows):
- MacOS: Docker GUI for MacOS
- Windows: Docker GUI for Windows
Here are some more resources, since this advice is based on mainly using MacOS and Linux:
- Installing Docker: https://docs.docker.com/get-docker/
- Installing
docker-compose: https://docs.docker.com/compose/install/
(Make sure you follow the NOTE above. Also, all commands here work on all OSes.)
You'll use docker-compose to launch the website. Make sure you're in the website repository's root directory. (To check, in your shell run pwd and you should see /path/to/site.) All of these commands must be run from the root of the site.
- To start the container:
docker-compose up -d. - To stop the container:
docker-compose down. - To view the logs:
docker-compose logs -f hugo. (These are helpful if the site "breaks/errors" – that is, stops compiling.) - To restart the container:
docker-compose restart. (Sometimes you'll want to clean-up the files in the container ~ e.g. say you hadlocalhost:6969/meetings/somethingbut restructured tolocalhost:6969/fa20/something, you'll find that the first URL still exists unless you restart the container. Don't bother with this unless changes are propagating and you need to see them ASAP.)
Feel free to inspect the docker-compose.yml and ask away. Once you've started the container, give it a few seconds to compile the site, then head over to http://localhost:6969/ to see a live rendition of the site.
Then personalize the site!
Please make sure you always pull, before committing or pushing to the repository! 😄
We will be using different branches for each Leadership Team member. When you are pushing changes, please make sure you are using your respective branch, instead of pushing to master.
If you are an Outside Collaborator, please create a new branch before pushing any changes!
When you are pushing to another branch, other than master, you won't be able to just type: git push.
Instead you'll type: git push origin <branch-name>.
To add a new new branch in the command line, type: git checkout -b <branch-name>.
If you would like to see the contents of other branches, type: git checkout <branch-name>.
To see the changes you've pushed, or another teammates changes, you'll have to visit: <branch-name>--acmw.netlify.app. Only changes pushed to master will render to ucfacmw.org.
Here you'll be able to get help with Hugo Documentation.
Here you'll be able to find help with Netlify. If you're an officer in our club and would like access to the account, please contact the current president.
If you're messing around with the HTML/CSS and what not (e.g. the buttons, containers, etc...) and need want some help, here's the Bootstrap Documentation.
Here's a playlist with tutorials for using Hugo and Bootstrap together.
Here's a list of forums, chats, or support pages we like to use if we need more answers:
- Hugo Forum
- Academic Community Chat
- Academic Support
- Stack Exchange
- Mostly Stack Overflow
- w3schools for more help with Boostrap
If you have any questions or concerns, please free to contact us:
- Contact Form
- Discord –– ping anyone with the @Officers role
⬇️ ⬇️ Documentation by George Cushen can be found below! ⬇️ ⬇️
Academic Kickstart: The Template for Academic Website Builder
Academic makes it easy to create a beautiful website for free using Markdown, Jupyter, or RStudio. Customize anything on your site with widgets, themes, and language packs. Check out the latest demo of what you'll get in less than 10 minutes, or view the showcase.
Academic Kickstart provides a minimal template to kickstart your new website.
- 📚 View the documentation
- 💬 Chat with the Academic community or Hugo community
- 🐦 Twitter: @source_themes @GeorgeCushen #MadeWithAcademic
- 💡 Request a feature or report a bug
- ⬆️ Updating? View the Update Guide and Release Notes
- ❤️ Support development of Academic:
- Academic Admin: An admin tool to import publications from BibTeX or import assets for an offline site
- Academic Scripts: Scripts to help migrate content to new versions of Academic
Copyright 2017-present George Cushen.
Released under the MIT license.
