Invitecode-website

Invitecode-website

šŸ¤‘ Discounts on your favorite services through invite codes

Invite-code.com

License: MIT medium: sandoche Twitter: farbodsaraf

All the invite codes at the right place šŸ·ļøšŸ¤‘

šŸ‘‰ Get invite codes


āš™ļø How to run

Install

npm install
bundler install

Development

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
    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:
    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

Copyright Ā© 2020 [Sandoche ADITTANE](https://www.sandoche.com) & [Farbod SARAF](https://farbodsaraf.com/)<br />
This project is [MIT](/LICENSE) licensed.