Juni Story Book

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Am I Responsive? YES!

Built With

• ExpressJS
• Handlebars View Engine
• MongoDB
• CKeditor
• Cloudinary
• MaterializeCSS
• Algolia Search
• Deployed on Heroku

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/juniHub/storybook-app.git

2. Install NPM packages

   npm install

3. Connect to your mongodb and add info in

   config.env

4. Run the project locally on http://localhost:3000

   npm run dev

Usage

For more examples, please refer to the Documentation. This will be continued for update and maintainance.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learned, inspired, and created. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Juni Nguyen - helloJuni

Project Link: https://github.com/juniHub/storybook-app

Acknowledgements

Inspired by storybook project from Traversy Media