Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sandoche/invitecode-website

🤑 Discounts on your favorite services through invite codes
https://github.com/sandoche/invitecode-website

code deals discounts invite invite-code invitecode jekyll progressive-web-app promo promocode pwa

Last synced: 3 months ago
JSON representation

🤑 Discounts on your favorite services through invite codes

Host: GitHub
URL: https://github.com/sandoche/invitecode-website
Owner: sandoche
License: mit
Created: 2018-06-28T18:49:04.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-06-08T22:37:35.000Z (over 1 year ago)
Last Synced: 2024-10-12T14:06:31.301Z (4 months ago)
Topics: code, deals, discounts, invite, invite-code, invitecode, jekyll, progressive-web-app, promo, promocode, pwa
Language: HTML
Homepage: https://invite-code.com/
Size: 40.3 MB
Stars: 10
Watchers: 4
Forks: 4
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Invite-code.com

All the invite codes at the right place 🏷️🤑

### 👉 [Get invite codes](https://invite-code.com)

## ⚙️ How to run

### Install

```sh
npm install
bundler install
```

### Development

```sh
npm run dev
```
## 🏷️ How to add codes

### Add a company
1. Choose an unique id for the company (`acme` for example)
2. Open `_data/companies.yml`
3. Add the unique id to `all`
4. At the end of the file add the companies metadata following this example
```yaml
acme: #replace acme by the unique id
name: ACME
title: Get a 20 € in your ACME account
color: '#f4f4f4' # should match the theme color of the company
guide: Create an account using this invite code and do a first purchase
link: /acme/
icon: acme.png
```
5. Add the icon of the company in `_images/icons/` using the same name that in the previous metadata

### Create a user
1. Choose an unique id as a username (`johndoe` for example)
2. Open `_data/users.yml`
3. Add the unique id to `all`
4. At the end of the file add the username followed by these 3 attributes `url`, `codes` and `companies` following this example:
```yaml
johndoe:
url:
uber: https://www.uber.com/invite/f416b
airbnb: https://abnb.me/e/JEIN6Vvx9N
acme: https://www.acme.com/code123
codes:
uber: f416b
airbnb: JEIN6Vvx9N
acme: code123
companies:
- uber
- airbnb
- acme
```

### Create a page for a company
1. At the root of the project create a `md` file with the same unique id as the company (`acme.md` for example)
2. Copy paste the following content and make sure to change the values of `title`, `permalink` and `company`, also `company`'s value should be the same as the unique id:
```yaml
---
layout: code
type: code
title: ACME promocodes
permalink: /acme/
company: acme # it should match the unique id defined previously
---
```

### Create a page for a user
1. At the root of the project create a `md` file with the same unique id as the username (`johndoe.md` for example)
2. Copy paste the following content and make sure to change the values of `title`, `permalink` and `username`, also `username`'s value should be the same as the username unique id:
```yaml
---
layout: list
type: list
title: John Doe's Promo codes
permalink: /johndoe/
username: johndoe # it should match the unique id defined previously
---
```

### Create a page for a promocode of a specific user
1. Each promocode added to a specific user should have its own page, so create a `md` file with the name of username and the unique id of the company (`johndoe_acme.md`)
2. Copy paste the following content and make sure to change the values of `title`, `permalink`, `username`, `company`, once again `username` should match the username unique id, and `company` the company's unique id:
```yaml
---
layout: code
type: code
title: John Doe's ACME promocode
permalink: /johndoe/acme/
username: johndoe # it should match the unique id defined previously
company: acme # it should match the unique id defined previously
---
```

## Authors

👤 **Sandoche ADITTANE & Farbod SARAF**

* Twitter: [@farbodsaraf](https://twitter.com/farbodsaraf)
* Github: [@sandoche](https://github.com/sandoche)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

## ⭐️ Show your support

Give a ⭐️ if this project helped you!

## ☕️ Buy me a coffee

If you like this project, feel free to donate: https://www.buymeacoffee.com/detoxify

## 📝 License