Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devict/hacktoberfest
Our own little local version of hacktoberfest
https://github.com/devict/hacktoberfest
github go golang hacktoberfest
Last synced: about 1 month ago
JSON representation
Our own little local version of hacktoberfest
- Host: GitHub
- URL: https://github.com/devict/hacktoberfest
- Owner: devict
- Created: 2016-10-01T06:46:36.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-21T15:06:56.000Z (over 1 year ago)
- Last Synced: 2024-04-14T19:50:49.701Z (10 months ago)
- Topics: github, go, golang, hacktoberfest
- Language: Go
- Homepage: https://hacktoberfest.devict.org
- Size: 2.37 MB
- Stars: 4
- Watchers: 5
- Forks: 22
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hacktoberfest
A little web app for tracking participation in the devICT Hacktoberfest event.
## Participate
Make Wichita a better place through code. Hop on over to the
[devICT Hacktoberfest app](https://devict-hacktoberfest.herokuapp.com) and
register with your GitHub profile.
# Development
Follow the steps below to get the app running locally on your system.
## Installation
Download & install
[Docker](https://docs.docker.com/install/#supported-platforms) on your system.
Create an application from your
[GitHub Settings page](https://github.com/settings/applications/new). Set the
**Homepage URL** to `http://localhost:8080` and **Authorization callback URL**
to `http://localhost:8080/auth/github`.
Copy the `secret.env.example` file and rename it to `secret.env`:
```
cp secret.env.example secret.env
```
Paste the **Client ID** and **Client Secret** from your registered GitHub
application into `secret.env`.
(If on Windows) Make sure your local repository path (for example `C:\Users\username\repos\job-board`) is available for Docker Filesharing by going to `Docker Dashboard > Settings > Resources > File Sharing`
Start the database in daemon mode:
```
docker compose up -d db
```
Start the web service:
```
docker compose up --build web
```
Install frontend assets:
```
npm install
```
Build the frontend assets:
```
npm run build
```
You're ready to go! Visit [localhost:8080](http://localhost:8080) in your
browser.
## Developing Locally
Using the configured Docker Compose file if you edit anything under `public/` or
`templates/` then the change will be available immediately. If you change any
`.go` files you will have to rebuild the image. While the web service is running
press ctrl + c to cancel the process and then run
`docker-compose up --build web` again to restart.
Running `npm run watch` will watch for frontend changes and rebuild CSS assets.
This website uses the Typicons icon library. [Download the SVG files from their website](https://www.s-ings.com/typicons/).
## Credit
The entire idea and name "Hacktoberfest" comes from the
[Digital Ocean event](https://hacktoberfest.digitalocean.com) by the same name.