Inkly

Inkly is a simple open-source email signature generator made with Nuxt and Tailwind CSS.

Live website

You can see it live at inkly.hrcd.fr.

Quick Setup

1. Clone this repository if you have access or download it from the store

git clone git@github.com:HugoRCD/inkly.git

2. Install dependencies

bun install

3. Start development server

bun dev

4. Generate static project

bun generate

5. Start production server

bun start

Contributing

To start contributing, you can follow these steps:

1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, feat/123 or fix/456.
4. Make changes following the local development steps.
5. Commit your changes following the Conventional Commits specification.
6. If your changes affect the code, run tests using bun run test.
7. Create a pull request following the Pull Request Template.
   • To be merged, the pull request must pass the tests/workflow and have at least one approval.
   • If your changes affect the documentation, make sure to update it.
   • If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !

Local development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using bun install
• Start development server using bun dev
• Open http://localhost:3000 in your browser

Published under the APACHE license.
Made by @HugoRCD and community 💛

---

🤖 auto updated with automd (last updated: Sat Aug 31 2024)