2 Minute Use Cases

Table of Contents

1. Overview
2. Installation
3. Implementing the Use Case
4. Running the Demo
5. Support
6. Contributing
7. License

Overview

This repository includes the source code for implementing use case demos as part of the '2 Minute Use Case' Series. This README provides a detailed explanation of the demos and instructions on how to implement them.

Installation

To install the project, follow these steps:

1. Clone the repository:

git clone https://github.com/DevCycleHQ/devcycle-use-cases.git

2. Install a compatible version of nodejs. Currently using lts/hydrogen.

If you use nvm to manage your node version you can just run:

nvm use

and it will install the correct version of nodejs for you.

3. Now install the necessary packages using yarn:

yarn

Implementing the Use Cases

Here are the steps for implementing the use case demos:

• Use Case 1: Early Access
• Use Case 2: User Opt-in

Please note that these are links to separate Markdown files, each containing specific implementation steps for each use case.

Running the Demo

To run the demo, follow these steps:

1. Run the development server:

yarn dev

2. Open http://localhost:3000 with your browser to see the result.

Support

If you have any problems or issues, please open a new issue in the repository, or contact Mark Allen on the DevCycle Discord.

Contributing

To contribute to this project, follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b <branch_name>
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively, see the GitHub documentation on creating a pull request.

Configurating Gitstream

If you want to run a fork of this repository with Gitstream follow their instruction on How to Setup gitStream with GitHub.

Not configuring it will not have any impact upon your fork.

License

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