Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/marcoroth/hotwire.io

Community-driven documentation and resource Hub for Hotwire.
https://github.com/marcoroth/hotwire.io

hacktoberfest hotwire html-over-the-wire javascript progressive-enhancements stimulus strada turbo

Last synced: about 2 months ago
JSON representation

Community-driven documentation and resource Hub for Hotwire.

Awesome Lists containing this project

README

        

# Hotwire.io

The JavaScript Ecosystem for Server-rendered Web-Applications.

## Getting started

### Running locally

#### Running app locally

1. Clone the repository:

```bash
git clone https://github.com/marcoroth/hotwire.io
```

2. Install dependencies:

```bash
cd hotwire.io
```

3. Setup the app (install dependencies, create the database, etc.)

```bash
bin/setup
```

4. Run the app locally:

```bash
bin/dev
```

5. The app should be now available at

```bash
open http://localhost:3000
```

#### Running linters locally

To run the linters with the provided configuration, follow these steps:

1. Open the project's root directory in the terminal.
2. Run the linting command:

```bash
bin/lint
```

3. Review the linting results.
4. Commit changes to your branch

#### Contributing

1. Fork the repository on GitHub.
2. Follow steps in "Running locally" section above
3. Update your git remote URL

```bash
git remote set-url origin https://github.com/[user]/hotwire.io
```

4. Fetch latest changes from your fork

```bash
git fetch origin
```

5. Create new branch for your feature

```bash
git checkout -b your-feature
```

6. Do your changes

7. Commit your work

```bash
git commit -m "Message"
```

8. Push your changes to your fork

```bash
git push origin
```

9. Open pull request on GitHub

### License

The project is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/).