Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 2.61 KB

README.md

File metadata and controls

117 lines (72 loc) · 2.61 KB
Raw

myTales: A Story Sharing App 📖

myTales is a vibrant platform designed for storytellers and readers alike. Whether you have a knack for crafting imaginative tales or enjoy getting lost in captivating narratives, myTales offers a seamless experience for all. Users can write, share, and discover stories across various genres, creating a community where creativity thrives. With user-friendly features and an intuitive interface, myTales makes it easy to share your stories with the world and find inspiration from others.

Table of Contents

Tech Stack

  • Vite + React
  • MERN Stack
  • Javascript
  • TailwindCSS + Vanilla CSS
  • Flowbite React
  • Firebase O-Auth
  • Redux for state management
  • Redux Persist for session caching
  • Email.js for mail services

Installation

Step-by-step guide on how to install and set up the project.

# Clone the entire repo.
git clone https://github.com/adarsh-k27r/myTales.git .

# Install Dependencies using npm.
npm install

# change directory
cd client

# Install Client/Frontend Dependencies using npm.
npm install

# Also Don't forget to add your own env variables.

Development Runtime

# Run the Backend using:
npm run dev

# Change Directory
cd client

# Run the Client application using:
npm run dev

Contact

Adarsh Kumar @ 21cs3060@rgipt.ac.in

Project Status

Completed ✌️

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

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