Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Icons as a tuple #52

Merged
merged 4 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
<p align="center">

![Cardie Logo](repo/images/logo_light.png#gh-dark-mode-only)
![Cardie Logo](repo/images/logo_dark.png#gh-light-mode-only)
<!-- ![Cardie Logo](repo/images/logo_light.png#gh-dark-mode-only)
![Cardie Logo](repo/images/logo_dark.png#gh-light-mode-only) -->

![Hacktoberfest Banner](repo/images/hacktoberfest24.png)

</p>

---

<div align="center">

[![](https://dcbadge.limes.pink/api/server/G24Ag9FqB8)](https://discord.gg/G24Ag9FqB8)
[![](https://img.shields.io/github/issues/nfoert/cardie?style=for-the-badge)](https://github.com/nfoert/cardie/issues)
[![](https://img.shields.io/github/license/nfoert/cardie?style=for-the-badge)](https://github/nfoert/cardie/blob/main/LICENSE)

**[Live Server](https://cardie-uwtwy.ondigitalocean.app/)**

**[Wiki](https://github.com/nfoert/cardie/wiki)** |
**[Releases](https://github.com/nfoert/cardie/releases)**

[![](https://img.shields.io/github/issues/nfoert/cardie?style=for-the-badge)](https://github.com/nfoert/cardie/issues)
[![](https://img.shields.io/github/license/nfoert/cardie?style=for-the-badge)](https://github/nfoert/cardie/blob/main/LICENSE)

**The latest changes are available in the [development](https://github.com/nfoert/cardie/tree/development) branch! Please check there for the most up to date changes.**

</div>

---

Design a unlimited number of business or information cards about yourself, share a link or QR code to them, print it out, and save other people's cards to your virtual wallet for later. Once you've created a card you can get analytics data on how your cards are getting visited, you can edit your cards as things change, and you can keep cards private so only people with a link to your card can see it.

<div align="center">
Expand All @@ -34,6 +42,12 @@ Design a unlimited number of business or information cards about yourself, share
> [!IMPORTANT]
> Cardie is currently in an open alpha. Things will be rapidly changing and bugs are to be expected.

## Hacktoberfest
Happy Hacktoberfest! I hope that you find this project interesting and that some issues offer a good learning experience! Help of any kind would be greatly appreciated.

- You can check out the [issues page](https://github.com/nfoert/issues) for anything that piques your interest, or you can check the [hacktoberfest tag](https://github.com/nfoert/cardie/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3Ahacktoberfest) for specific issues I've selected for this Hacktoberfest.
- Additionally, please check out [contributing](#contributing) for some information on how you can contribute to this project.

## Installation

First, clone this repository using the following command
Expand Down Expand Up @@ -89,4 +103,4 @@ I'd love to see contributions to this project! Please check out the [issues](htt

Additionally, check [TODO.md](TODO.md) for a rough todo list of things that need implemented, and the [wiki](https://github.com/nfoert/cardie/wiki) for some information on how to work with some of the existing systems.

When contributing, first fork this repository. If you want the latest changes uncheck the `Copy the main branch only` option. Then, create a new branch with your change in it, either from the `main` branch or the `development` branch. Finally, open a pull request which merges into the `development` branch. Your changes will be reviewed and merged when ready.
When contributing, first fork this repository. To ensure you're getting the latest development changes uncheck the `Copy the main branch only` option. Then, create a new branch with your change in it, either from the `main` branch or the `development` branch. Finally, open a pull request which merges into the `development` branch. Your changes will be reviewed and merged soon. Thanks for contributing to Cardie!
6 changes: 3 additions & 3 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
This list shows some of the next things that need implemented for Cardie. I want to figure out a better solution for a todo list in future but this works for now.

- [x] Make UIs mobile friendly [issue](https://github.com/nfoert/cardie/issues/4)
- [ ] **Customization**
- [ ] Background Color
- [ ] Secondary Color
- [x] **Customization**
- [x] Background Color
- [x] Secondary Color
- [ ] Collapse Links
- [ ] If no text, make link button only
- [x] **Authentication UI improvements** [issue](https://github.com/nfoert/cardie/issues/2)
Expand Down
Loading