Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/astralapp/astral

Organize Your GitHub Stars With Ease
https://github.com/astralapp/astral

github organize stars tags

Last synced: 3 days ago
JSON representation

Organize Your GitHub Stars With Ease

Awesome Lists containing this project

README

        

# Astral ![run-tests](https://github.com/astralapp/astral/workflows/run-tests/badge.svg)

An open source application that allows you to organize your GitHub Stars with ease. Use the [hosted version](https://app.astralapp.com) free, or self-host your own instance with the instructions below!

## Installation

### Prerequisites

- To run this project, you must have PHP 7 Node.js, and Yarn installed.
- You should setup a host on your web server for your local domain. For this you could also configure Laravel Homestead or Valet.
- [Create a new GitHub OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) so you can plug in your API keys.

### Step 1

Begin by cloning this repository to your machine, and installing all Composer & NPM dependencies.

```bash
git clone [email protected]:astralapp/astral.git
cd astral && composer install && yarn
php artisan astral:install
yarn dev
```

### Step 2

Next, boot up a server to visit the app. If you're using a tool like Laravel Valet, the URL will likely default to `http://astral.test`. That's pretty much it!

## Deploying

- 1-Click Install with [Cloudron](https://www.cloudron.io/store/com.astralapp.cloudronapp.html)

## Contributing

As the `next` branch is the future of this project, I kindly ask that you do _not_ submit any pull requests to the `master` branch with new features, as it may have already been covered in the `next` branch, or your code may be incompatible. If you have found a bug or security issue that you would like to fix, I will still accept any pull requests for these cases. Thank you for understanding!