Susie is a website aimed at Sustainable Software Development and consists of:

• Analysis Tool 🔍 - Check the sustainability of a GitHub repository
• Guides 📰 - Learn more about sustainable software development

Installation

You should have Node.js, npm and git installed on your machine.

1. Clone the repository to your local machine.

   git clone https://github.com/philippedeb/susie.git

2. Navigate to the project directory.

   cd your-repository

3. Install the dependencies using pnpm (faster and more efficient compared to npm).

   npm i -g pnpm
   pnpm i

4. Run the project.

   pnpm run dev

Contributing

Contributions are always welcome! 👋

Read the contribution guidelines and code of conduct.

If you like the project, but just don’t have time to contribute, that’s fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

• ⭐ Star the project
• ✉️ Post about it (e.g. Twitter, LinkedIn, Reddit, etc.)
• 🔗 Refer this project in your project’s readme
• 💬 Mention the project at local meetups and tell your friends/colleagues

Note: early contributions of the maintainers did not follow the contribution guidelines due to a rushed production environment (Susie started as a university project!). We are working on improving the codebase and will be following these guidelines from now on.

License

This project is licensed under the terms of the GNU AGPLv3 license.