Skip to content

Community-driven documentation and resource Hub for Hotwire.

License

Notifications You must be signed in to change notification settings

marcoroth/hotwire.io

Repository files navigation

Hotwire.io

The JavaScript Ecosystem for Server-rendered Web-Applications.

Getting started

Running locally

Running app locally

  1. Clone the repository:
git clone https://github.com/marcoroth/hotwire.io
  1. Install dependencies:
cd hotwire.io
  1. Setup the app (install dependencies, create the database, etc.)
bin/setup
  1. Run the app locally:
bin/dev
  1. The app should be now available at http://localhost:3000
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:
bin/lint
  1. Review the linting results.
  2. 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
git remote set-url origin https://github.com/[user]/hotwire.io
  1. Fetch latest changes from your fork
git fetch origin
  1. Create new branch for your feature
git checkout -b your-feature
  1. Do your changes

  2. Commit your work

git commit -m "Message"
  1. Push your changes to your fork
git push origin
  1. Open pull request on GitHub

License

The project is available as open source under the terms of the MIT License.