https://github.com/kartikmanimuthu/feature-flags-node-workshop
Feature Flags Workshop (Launch Darkly) - Node.js & Express.js Template
https://github.com/kartikmanimuthu/feature-flags-node-workshop
express feature-flags launchdarkly nodejs
Last synced: about 2 months ago
JSON representation
Feature Flags Workshop (Launch Darkly) - Node.js & Express.js Template
- Host: GitHub
- URL: https://github.com/kartikmanimuthu/feature-flags-node-workshop
- Owner: kartikmanimuthu
- Created: 2023-07-23T11:30:03.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-23T11:37:22.000Z (almost 3 years ago)
- Last Synced: 2025-10-10T21:44:27.029Z (9 months ago)
- Topics: express, feature-flags, launchdarkly, nodejs
- Language: JavaScript
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Feature Flags Workshop - Node.js & Express.js Template
 
This repository is a template for the Feature Flags Workshop. It's a boilerplate project that leverages Node.js and Express.js to demonstrate the powerful concept of feature flags in a practical, hands-on workshop.
## 🎯 Overview
Feature flags, or feature toggles, are a software development technique that allows developers to enable or disable features in a live environment without deploying new code. This provides a host of benefits including safer deployments, easier testing, and the ability to quickly roll back problematic features. This workshop will guide you through implementing your first feature flag.
## 💾 Prerequisites
Ensure you have the following installed on your local machine:
- Node.js (v12.x or newer)
- npm (usually bundled with Node.js)
## ⚙️ Installation & Set Up
1. Clone this repository to your local machine:
```
git clone https://github.com//feature-flags-node-workshop.git
```
2. Navigate into the project directory:
```
cd feature-flags-node-workshop
```
3. Install the project dependencies:
```
npm install
```
4. Rename `.env.template` to `.env` and fill in the required environment variables.
## 🚀 Running the Application
To start the server, use the following command:
```
npm start
```
By default, the application runs on port 4000.
## 🏗️ Usage
Upon setting up the project, you can start implementing feature flags. The workshop exercises are located in the `/exercises` directory. Each exercise will guide you through the process of implementing a feature flag.
## ✅ Testing
To run tests, use the following command in the project root directory:
```
npm test
```
## 📁 Project Structure
Our Express.js application follows the MVC architecture pattern and the file structure is divided accordingly. The main folders are:
- `routes`: This folder is responsible for routing the application endpoints.
- `utils`: This folder contains utility modules that can be used across the application.
## 📜 Environment Variables
This project uses environment variables for configuration. Rename the `.env.template` file to `.env` and fill in the required values.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com//feature-flags-workshop/issues) for any outstanding items. If you want to contribute, please follow these steps:
1. Fork this repository.
2. Create a branch: `git checkout -b `.
3. Make your changes and commit them: `git commit -m ''`
4. Push to the original branch: `git push origin /`
5. Create the pull request.
Alternatively, see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## 📄 License
This project is licensed under the MIT License - see the `LICENSE.md` file for details.
## 💬 Contact
If you have any questions, concerns, or feedback - feel free to reach out!
## 🙏 Acknowledgements
We would like to extend our sincerest gratitude to all the contributors whose efforts have made this project possible. Your contribution to open-source is greatly appreciated! Happy coding!