https://github.com/do-community/hacktober-board
Hacktoberfest Board
https://github.com/do-community/hacktober-board
Last synced: about 1 year ago
JSON representation
Hacktoberfest Board
- Host: GitHub
- URL: https://github.com/do-community/hacktober-board
- Owner: do-community
- Created: 2019-09-27T10:08:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T07:45:02.000Z (over 3 years ago)
- Last Synced: 2025-03-28T00:44:09.303Z (about 1 year ago)
- Language: PHP
- Homepage: http://hacktober-board.com
- Size: 394 KB
- Stars: 5
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## Hacktober Board
Hacktober-board is an unofficial **Open Issues Board** for [Hacktoberfest](https://digitalocean.com). This project is built with [Laravel](https://laravel.com).
It is intended to help users, especially beginners, finding issues they can contribute to in order to participate in Hacktoberfest.
## Setting Up a Dev Environment
A Docker dev environment is included. You'll need **Docker** and **Docker Compose** installed. To set these up, you can follow [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-18-04).
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
### Fork and Clone
If you are planning to contribute, you will need to:
1) fork this repository in GitHub
1) create a local clone of your fork.
If you're not familiar with this process, [click here for the really detailed version](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
If you're not planning to contribute and just want to play with hacktober-board in a local dev environment, you can simply clone this repo
### Running the App on Docker
First, you need a `.env` file. If you have a particular need to customize your `.env` you may do so, but for most developers you can just use `.env.example`. Run this in your project root (where you cloned the repo):
```shell
cp .env.example .env
```
Now get your dev environment up and running by bringing up the docker containers:
```shell
docker-compose up
```
When the containers are up, you need to create a new MySQL user by logging in the container:
```shell
docker-compose exec db bash
```
Log into MySQL:
```shell
mysql -u root -p
```
The root MySQL password for the `db` container is `password`.
Then, create a new user while granting permissions to the `hacktober` database, and flush privileges:
```mysql
GRANT ALL ON hacktober.* TO 'hacktober-user'@'%' IDENTIFIED BY 'password';
FLUSH PRIVILEGES;
```
Exit the MySQL prompt and the container, coming back to your regular shell.
To create the database tables, run migrations inside the container:
```shell
docker-compose exec app php artisan migrate
```
To fill the database with sample data, run the `db:seed` command:
```shell
docker-compose exec app php artisan db:seed
```
To import real issues from Github, you'll need to define a Github API Token in the `.env` file. Look for the variable `GITHUB_API_TOKEN`.
After setting up the API key, you can import issues with:
```shell
docker-compose exec app php artisan hacktober:fetch
```
This will populate the database with real issues from Github.
## About
Hacktober-Board was initially created at the internal [DigitalOcean](https://digitalocean.com) Hackaton a.k.a. Shark-a-Hack, September 2019 edition.
The front-end was designed by [Eileen Ani](https://github.com/eileenani) based on the official Hacktoberfest page.
## Contributing
Contributions are welcome. Please create an issue or assign yourself an existing issue so everybody knows what is taken. This can be as easy as leaving a comment like "I'll grab this one" in the issue you want to work on :)
If you are new to open source and Git, you can check this excellent series on [How to Contribute to Open Source](https://www.digitalocean.com/community/tutorial_series/an-introduction-to-open-source) by [Lisa Tagliaferri](https://twitter.com/lisaironcutter) on the DigitalOcean Community.