Simple Timeline Maker (STM) is a web app designed to help you create custom timelines with ease. STM is user-friendly, responsive, and fully customizable, allowing users to visually map out events with simplicity. Whether you're organizing a project, documenting historical events, or tracking personal milestones, STM makes organizing and sharing timelines straightforward and efficient.
- Customizable Events: Add events with customizable details to your timeline.
- Responsive Design: Works seamlessly across devices (desktop and mobile).
- Easy-to-Use: Intuitive interface for creating, editing, and viewing timelines.
Follow these steps to clone the repository and set up the project locally.
Clone the repository to your local machine using the following command:
git clone https://github.com/sayantan-2/Simple-timeline-maker.git
Once cloned, navigate into the project directory:
cd Simple-timeline-maker
Install the required dependencies using either npm
or yarn
.
For npm users:
npm install
For yarn users:
yarn install
Run the following command to start the app in development mode:
For npm:
npm start
For yarn:
yarn start
Once the development server is up, open your browser and navigate to:
http://localhost:3000
This will allow you to interact with the app in your local environment.
To build the project for production, use the following command:
For npm:
npm run build
For yarn:
yarn build
This will generate an optimized build of the app, ready to be deployed.
Contributions are welcome! If you'd like to contribute to this project, please feel free to submit a pull request or open an issue. Make sure to follow best practices and write clear, concise code.
This project is licensed under the MIT License, meaning you are free to use, modify, and distribute the code with proper attribution. However, commercial use of this project without permission is restricted.
All updates, bug fixes, and new features are documented in the Changelog.