Skip to content

Commit

Permalink
Split up "Contributing" section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoroth committed Oct 21, 2023
1 parent c7ddea0 commit 45d86ca
Showing 1 changed file with 62 additions and 20 deletions.
82 changes: 62 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,82 @@
# Hotwire.io
## Hotwire.io

The JavaScript Ecosystem for Server-rendered Web-Applications.

## Getting started
### Getting started

## Running locally
#### Running locally

1. Fork the repository on Github.
1. Clone the repository:

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

git clone git@github.com:your_username/hotwire.io.git
2. Install dependencies:

3. Install dependencies:
```bash
cd hotwire.io
```

cd hotwire.io
bundle install
3. Setup the app (install dependencies, create the database, etc.)

4. Create the database, and run the migrations:

rails db:create
rails db:migrate
```bash
bin/setup
```

5. You might need to upgrade if your prompted to:
4. Run the app locally:

bundle exec vite upgrade
```bash
bin/dev
```

6. You can run the app locally:
5. The app should be now available at http://localhost:3000

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

6. The app should be now available at http://localhost:3000/
#### Contributing

http://localhost:3000/
1. Fork the repository on GitHub.

2. Follow steps in "Running locally" section above

## License
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/).

0 comments on commit 45d86ca

Please sign in to comment.