https://github.com/davidumoru/satori

https://github.com/davidumoru/satori

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/davidumoru/satori
• Owner: davidumoru
• Created: 2024-12-10T20:45:20.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-10T23:51:30.000Z (5 months ago)
• Last Synced: 2025-02-08T04:27:49.942Z (3 months ago)
• Language: TypeScript
• Size: 73.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Satori

Generate personalised roadmaps to learn anything

## Installation

To set up the project locally, follow these steps:

1. Clone the repository:

   ```bash

   git clone https://github.com/davidumoru/satori.git

   ```

2. Navigate to the project directory:

   ```bash

   cd satori

   ```

3. Install the dependencies:

   ```bash

   npm install

   ```

4. Start the development server:

   ```bash

   npm run dev

   ```

## Contributing

Contributions are welcome! Please follow these steps to contribute:

1. Fork the repository.

2. Create a new branch:

   ```bash

   git checkout -b feature/your-feature-name

   ```

3. Make your changes and commit them:

   ```bash

   git commit -m 'Add some feature'

   ```

4. Push to the branch:

   ```bash

   git push origin feature/your-feature-name

   ```

5. Open a pull request to the `main` branch.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Acknowledgments

- [davidumoru](https://github.com/davidumoru) for creating and maintaining this project.