https://github.com/hugorcd/inkly
The most simple open-source email signature generator
https://github.com/hugorcd/inkly
email email-signature nuxt open-source
Last synced: 3 months ago
JSON representation
The most simple open-source email signature generator
- Host: GitHub
- URL: https://github.com/hugorcd/inkly
- Owner: HugoRCD
- License: apache-2.0
- Created: 2024-08-28T18:12:54.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-03-08T06:43:43.000Z (3 months ago)
- Last Synced: 2025-03-08T07:28:45.266Z (3 months ago)
- Topics: email, email-signature, nuxt, open-source
- Language: Vue
- Homepage: https://inkly.hrcd.fr
- Size: 1.55 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
# Inkly
Inkly is a simple open-source email signature generator made with [Nuxt](https://nuxt.com/) and [Tailwind CSS](https://tailwindcss.com/).
## Live website
You can see it live at [inkly.hrcd.fr](https://inkly.hrcd.fr/).
## Quick Setup
1. Clone this repository if you have access or download it from the store
```bash
git clone [email protected]:HugoRCD/inkly.git
```
2. Install dependencies
```bash
bun install
```
3. Start development server
```bash
bun dev
```
4. Generate static project
```bash
bun generate
```
5. Start production server
```bash
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](https://www.conventionalcommits.org/en/v1.0.0/) specification.
6. If your changes affect the code, run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
- 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](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `bun install`
- Start development server using `bun dev`
- Open [http://localhost:3000](http://localhost:3000) in your browser
Published under the [APACHE](https://github.com/hugorcd/inkly/blob/main/LICENSE) license.
Made by [@HugoRCD](https://github.com/HugoRCD) and [community](https://github.com/hugorcd/inkly/graphs/contributors) 💛
---
_🤖 auto updated with [automd](https://automd.unjs.io) (last updated: Sat Aug 31 2024)_