Skip to content

Commit

Permalink
Updated steps
Browse files Browse the repository at this point in the history
  • Loading branch information
ulises-jeremias committed Sep 18, 2023
1 parent e924f7f commit 307ca82
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
10 changes: 0 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,3 @@ GitHub provides additional document on [forking a repository](https://help.githu
## Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

## Coding Guidelines

### Examples

TODO

### Packages

TODO
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,28 @@ In the project directory, you can run:
| `format` | Formats the project using [Prettier](https://prettier.io/) |
| `type-check` | Runs [TypeScript](https://www.typescriptlang.org/) type checking |

## Running Locally

When contributing you might want to test your changes locally before opening a PR. To do so, you can use the `create-awesome-node-app` CLI to create a new project and test your changes.

```sh
# Clone the repository
git clone https://github.com/Create-Node-App/create-node-app.git

# Move into the directory
cd create-node-app

# Setup your local environment
fnm use
npm install

# Build the CLI
npm run build -- --filter create-awesome-node-app

# Create a new project
./packages/create-awesome-node-app/index.js my-app
```

## 🤝 Contributing

- Contributions make the open source community such an amazing place to learn, inspire, and create.
Expand Down

0 comments on commit 307ca82

Please sign in to comment.