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

https://github.com/michaltalaga17/project-starter

starter for web project
https://github.com/michaltalaga17/project-starter

2024 parcel react scss starter

Last synced: about 1 month ago
JSON representation

starter for web project

Awesome Lists containing this project

README

          

# Project Starter

![License](https://img.shields.io/badge/license-MIT-green)
![Node.js](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)
![Parcel](https://img.shields.io/badge/parcel-%5E2.0.0-orange)
![React](https://img.shields.io/badge/react-%5E17.0.0-blue)
![Sass](https://img.shields.io/badge/sass-latest-pink)

This is a project starter template for web projects with Parcel bundler. It includes configurations and dependencies to help you kickstart your web development projects.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Scripts](#scripts)
- [Contributing](#contributing)
- [License](#license)

## Installation

1. Clone this repository:

```bash
git clone https://github.com/MichalTalaga17/project-starter.git
cd project-starter
2. Install the project dependencies:

```bash
npm install

## Usage

You can use this project starter by following these simple steps:

1. Start the development server:

```bash
npm start

2. Open your web browser and navigate to http://localhost:1234 to see your project in action.
3. Make changes to your source files in the src/ directory, and the development server will automatically reload your project.
4. When you're ready to build for production, use the following command:

```bash
npm run build

This will create an optimized production build in the dist/ directory.

## Scripts

This project includes several NPM scripts to help you with common tasks:

- npm run reset: Delete the dist/ directory and clear Parcel's cache.
- npm run start: Start the development server.
- npm run build: Build your project for production.
- npm run watch: Watch your project for changes.

## Contributing

Feel free to contribute to this project. If you encounter any issues or have suggestions for improvements, please create an issue on [GitHub](https://github.com/MichalTalaga17/project-starter/issues).

## License

Feel free to use, change and rewrite it.

Happy coding!