https://github.com/OmgRod/hubble-alpha
https://github.com/OmgRod/hubble-alpha
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/OmgRod/hubble-alpha
- Owner: OmgRod
- License: gpl-3.0
- Created: 2024-11-17T10:01:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T13:24:39.000Z (over 1 year ago)
- Last Synced: 2024-11-17T13:41:02.597Z (over 1 year ago)
- Language: JavaScript
- Size: 150 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hubble
# WARNING: This repository is archived. For the updated version, go to [hubble-sm/web](https://github.com/hubble-sm/web)
## Table of Contents
- [About Hubble](#about-hubble)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
- [Contact](#contact)
## About Hubble
Hubble is a next-generation social media platform designed to offer a clean, minimalistic experience while providing all the essential features of popular social media sites in one place. The project is open-source and built with the help of a passionate community of developers, designers, and contributors from around the world.
The main goal of Hubble is to combine simplicity with functionality, offering users a seamless social media experience without unnecessary complexity. Whether you're looking to connect with friends, share content, or engage in discussions, Hubble aims to be an all-in-one platform that keeps things straightforward and easy to use.
### Key Features
- Posts
- Videos
- Chats
- Profiles
## Getting Started
To get started with Hubble, follow these steps:
1. **Clone the Repository**:
First, clone the Hubble repository to your local machine.
```bash
git clone https://github.com/OmgRod/hubble.git
```
2. **Set up the Development Environment**:
Follow the instructions in the [setup guide](https://github.com/OmgRod/hubble/wiki/Setup-Guide) to configure your environment.
3. **Run the Application**:
Once your environment is set up, you can start running the application locally using the following command:
```bash
npm start
```
4. **Explore the Code**:
Familiarize yourself with the codebase. The main directories are:
- `/src`: Contains sass code.
- `/views`: Contains ejs code.
- `/public`: Contains js code, manifest, and icons.
## Contributing
We love contributions from everyone! Here's how you can help:
1. **Find an Issue**:
Check out the [Issues](https://github.com/OmgRod/hubble/issues) page for bugs or tasks that need help.
2. **Fork the Repository**:
Fork the repository to your GitHub account and clone it to your local machine.
3. **Create a Branch**:
Create a new branch for your changes.
```bash
git checkout -b feature-name
```
4. **Make Changes**:
Make your changes to the codebase. Ensure that you follow our coding standards and best practices.
5. **Run Tests** (coming soon):
Make sure all tests pass before submitting a pull request. Use the following command to run tests:
```bash
npm test
```
6. **Submit a Pull Request**:
Once you're satisfied with your changes, submit a pull request to the `main` branch.
### Guidelines for Contributions
- Please make sure your pull request includes clear and concise commit messages.
- Each pull request should focus on a single issue or feature.
- If you're working on a bug fix, include steps to reproduce the issue, and ensure it's resolved.
## Code of Conduct
By participating in the Hubble project, you agree to abide by our [Code of Conduct](https://github.com/OmgRod/hubble/blob/main/CODE_OF_CONDUCT.md). We are committed to creating a welcoming and respectful environment for all contributors.
## License
Hubble is licensed under the [GNU General Public License v3.0](https://github.com/OmgRod/hubble/blob/main/LICENSE). See the LICENSE file for more details.
## Contact
If you have any questions or need assistance, feel free to reach out to us:
- Community Discussions
- Open an Issue
- Contact Maintainers
Thank you for being part of the Hubble project. We look forward to your contributions!