https://github.com/niloysikdar/kahani

Time to reveal some untold stories
https://github.com/niloysikdar/kahani

express jwoc jwoc2k22 mongoose nextjs nodejs typescript

Last synced: 8 days ago
JSON representation

Time to reveal some untold stories

• Host: GitHub
• URL: https://github.com/niloysikdar/kahani
• Owner: niloysikdar
• Created: 2022-01-29T09:20:05.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-28T08:17:16.000Z (over 2 years ago)
• Last Synced: 2023-03-10T23:45:20.783Z (over 1 year ago)
• Topics: express, jwoc, jwoc2k22, mongoose, nextjs, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 308 KB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






    

  
Kahani


  


    Time to reveal some untold stories

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  


  Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Roadmap

    
Contributing

    
License

    
Contributors

  


## About The Project

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

### Built With

- [React](https://reactjs.org)

- [Next.js](https://nextjs.org)

- [TypeScript](https://www.typescriptlang.org)

## Getting Started

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

### Prerequisites

**_We strictly use [yarn](https://yarnpkg.com/) for managing the packages/dependencies. You need to install [yarn](https://yarnpkg.com/) to successfully run this project locally._**

- yarn

  ```sh

  npm install -g yarn

  ```

### Installation

1. Fork the project first

2. Clone the forked repo

   ```sh

   git clone https://github.com//Kahani.git

   ```

3. In the project directory, install the packages using

   ```sh

   yarn

   ```

   or

   ```sh

   yarn install

   ```

4. Run the app in the development mode using

   ```sh

   yarn start

   ```

   Open [http://localhost:3000](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](https://github.com/niloysikdar/Kahani/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`](https://github.com/niloysikdar/Kahani/blob/main/LICENSE) for more information.

## Contributors

Thanks to these wonderful people ✨✨: