/Kahani

Time to reveal some untold stories

Primary LanguageTypeScript


Logo

Kahani

Time to reveal some untold stories

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contributors

About The Project

Full-fledged web application for Stories and Poems with both visual and audio support

Built With

Getting Started

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

Prerequisites

We strictly use yarn for managing the packages/dependencies. You need to install yarn to successfully run this project locally.

  • yarn 
    npm install -g yarn

Installation

  1. Fork the project first

  2. Clone the forked repo

    git clone https://github.com/<your_name>/Kahani.git

  3. In the project directory, install the packages using

    yarn

    or

    yarn install

  4. Run the app in the development mode using

    yarn start

    Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.
    You will also see any lint errors in the console.

Roadmap

See the open issues for a list of proposed features (and known issues). Feel free to raise new issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

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

Contributors

Thanks to these wonderful people ✨✨: