Skip to content

Latest commit

 

History

History
157 lines (122 loc) · 5.11 KB

README.md

File metadata and controls

157 lines (122 loc) · 5.11 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Pokemon Soul Link

An app designed to help keep track of nuzlocke soul-link playthroughs in a user friendly manner

View Demo · Report Bug · Request Feature

image Screenshot

Table of Contents

About The Project

This is a tool designed to help people keep track of their pokemon in a nuzlocke soul link challange. No login or signup is required, and if you don't already have a list, you can start a new with a simple click!

Current Features

  1. Instant Syncing Between Users
  2. Create New Links
  3. Search Links
  4. Distory Links
  5. Easy URL Sharing of Lists

Built With

Getting Started

To get a local copy up and running follow these simple example steps. instructions are written for yarn but npm works as well.

Prerequisites

If you wish to work on the website, you'll need to make sure you have either npm or yarn installed.

  • yarn 
    https://classic.yarnpkg.com/lang/en/docs/install
  • npm 
    https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

You'll also need to install and setup Firebase if you plan on testing locally or deploying new cloud function code.

  • Firebase 
    https://firebase.google.com/docs/functions/get-started#set-up-node.js-and-the-firebase-cli

Installation

  1. Clone the repo
git clone https://github.com/EladKarni/soul-link.git
  1. Install packages
yarn
  1. Run local dev server
yarn start
  1. Make sure you change template.env.local to .env.local and add the required fields from your Firebase config file.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.