hackclub-nest

mirror of https://github.com/neongamerbot-qk/hackclub-nest synced 2024-11-23 17:03:40 +00:00

No description

Find a file

Zeon d0504d5da3 chore(ci): automated push		2024-09-13 19:03:08 +00:00
.config	chore(ci): automated push	2024-09-13 19:03:08 +00:00
.github/workflows	Update deploy.yml	2024-09-10 21:24:25 -04:00
.ssh	test .gitignore	2024-09-11 00:22:36 +00:00
automated	chore(ci): automated push	2024-09-12 00:08:01 +00:00
default_stuff	feat(main): init	2024-09-11 00:11:58 +00:00
pub	chore(pub/index.html): hb branding	2024-09-13 13:53:47 -04:00
sent/cur	chore(ci): automated push	2024-09-13 01:42:01 +00:00
.bashrc	chore: add some stuff	2024-09-10 23:01:40 -04:00
.gitignore	chore(ci): automated push	2024-09-13 18:46:59 +00:00
.lesshst	chore: cleanup	2024-09-13 18:52:24 +00:00
.profile	feat(main): init	2024-09-11 00:11:58 +00:00
.selected_editor	feat(main): init	2024-09-11 00:11:58 +00:00
Caddyfile	feat(main): init	2024-09-11 00:11:58 +00:00
clean.sh	chore(ci): automated push	2024-09-13 18:46:59 +00:00
install_cron_to_systemd.sh	chore(ci): automated push	2024-09-13 18:46:59 +00:00
mass_delete_emails_reminder.sh	feat(main): init	2024-09-11 00:11:58 +00:00
README.md	chore: readme	2024-09-11 00:32:36 +00:00
reset_git.sh	chore(ci): automated push	2024-09-11 02:38:52 +00:00
TODO.md	enhancement(lint): Fix lint errors for TODO.md	2024-09-11 03:01:44 +00:00
update_git.sh	chore(ci): automated push	2024-09-11 02:38:52 +00:00

README.md

Hackclub

My hackclub instance WIP.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

{desc}

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: NeonGamerBot-QK, hackclub-nest, twitter_handle, linkedin_username, project_title, project_description

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

npm
```
npm install npm@latest -g
```

Installation

Get a free API Key at https://example.com

Clone the repo

git clone https://github.com/NeonGamerBot-QK/hackclub-nest.git

Install NPM packages
```
npm install
```
Enter your API in config.js
```
const API_KEY = "ENTER YOUR API";
```

Change git remote url to avoid accidental pushes to base project

git remote set-url origin NeonGamerBot-QK/hackclub-nest
git remote -v # confirm the changes

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

Feature 1
Feature 2
Feature 3
- Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Neon - neon@saahild.com

Project Link: https://github.com/NeonGamerBot-QK/hackclub-nest

(back to top)

Acknowledgments

(back to top)