Skip to content

sandoche/Invitecode-website

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

🀝 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 & Farbod SARAF
This project is MIT licensed.