Skip to content

A template to showcase portfolio projects. Develop your components in Storybook and show them right in your App. Simple deployment of your App including Storybook to feature your development process.

License

Notifications You must be signed in to change notification settings

mhstrkmp/awesome-project-template

Repository files navigation

Node.js CI

😎 Awesome Project Template 😎

Getting Started

  1. Click Use this template. This will create a new repository for you based on this template.
  2. Clone the code to your local machine.
  3. Run npm install in the root directory of your project folder.
  4. Happy hacking ...

Available Scripts

In the project directory, you can run:

npm run start

To start the server.

npm run server

To start the server with Nodemon. That's especcialy useful if you are developing the server file. Nodemon handles restarting the server on change for you.

npm run client

To start the create-react-app.

npm run storybook

To start storybook.

npm run dev

To start server and client with concurrently.

npm run test

To run your tests.

npm run build

To build create-react-app and storybook. Normally you wouldn't do this, as your deployment pipeline will take care of this.

Deployment

Configuration is optimized for deployment with Heroku. If you want to deploy this somewhere else you maybe have to change the configuration files.

Learn More

Credits

This project is inspired by cra-with-api

About

A template to showcase portfolio projects. Develop your components in Storybook and show them right in your App. Simple deployment of your App including Storybook to feature your development process.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published