switchfeat-com / switchfeat Goto Github PK

Even thought the codebase already contains a MongoDBManager, it needs to be tidied up and tested.

A proper configuration forMongoDB, including any Docker configuration to install MongoDB locally needs to be added.

The documentation for SwitchFeat is meant to be contained in the https://github.com/switchfeat-com/docs repo which is also public.

It's a repo generated by Mintlify, which should simplify the creation of well made documentions pages structure.

Contributions are highly appreciated on this repo as well.

A numberic condition should include the following checks:

"gt" | "lt" | "gte" | "lte" | "equals" | "notEquals"

between a the given context (number) and the condition value.

The SdkService should be updated with a new condtion matcher to evaluate this condition.

The dashboard and API should support basic CRUD operations to the flags entity.

If there is only one option in the segments dropdown of the Flags rules, the segment cannot be added to the the final list.

Flags can define their status based on specific conditions. This task is about defining the criteria and the logic operations that the user might use to control flags.

Discussed in https://github.com/orgs/switchfeat-com/discussions/59

The first iteration of the dashboard page should fairly simple but eye catching.
I would think having cards showing some stats against how many flags / segments / rules have been created. how many flags are enabled.

Once we have the basic stuff, we might expand with some more in depth analytics, charts, etc.

This tasks involves implementing basec CRUD operations for Flags:

Create flag
Delete flag
Edit flag

The SDK is going to use a dedicated set of routes mainly around reading the state of a flag.
The SDK can only read data and not change the datastore.

Possible endpoints:

• evaluate-flag (this is half done already)
• get-flags
• get-segments
• get-conditions-by-segment
• get-rules-by-flag

Every action on a flag/segment/rule should be audited specifying:

• action type: create/update/delete
• entity involved: flag.segment/rule/etc..
• username
• timestamp

A rule defines the connection between flags and segments

The user can assign zero or more rules to a flag.

The API will traverse each rule assigned to a flag to decide if that flag should return true or false response.

The curernt SDK API doesn't offer any kind of authetication at the moment. This task is about adding an APIKey parameter that need to be added to header of any SDK API request.

The current http calls that the React app sends to the server are pretty much a copy and paste. Would be nice to have a centralized http client which all components would use to send reaquests to the backend.

To help users to learn how to use SwitchFeat, a product tour should be implemented using Driver.js library.

The documentation project can be found at this repo: https://github.com/switchfeat-com/docs

This issue is about adding the following endpoints to it, with input params/return types/etc.
Please follow the template here.

A segment is made of one or more conditions.

A condition is made of the following properties:

• context (e.i. name, email, country)
• type of condition (i.e. string, number, boolean, datetime)
• operator (dependent on the type).
• value

Types: Specification from OpenFeature

boolean: true, false
string: startsWith, endsWith, equals, notEquals
number: eq, neq, gt, lt, get, let
datetime: before, after, at, not at, before or at, after or at

An example of a condition would be:

-> email - context
-> string - type
-> endsWith - op
-> @gmail.com - value

On solution to that is to create a .env.example file which would just enlist the evironment variables needed, which the user will have to fill in.

The user will have to manually do that once the docker image has been downloaded and installed.

As a developer I would like to use a generic notification system which can be used in multiple places in the UI.

Every time the user execute an action, like create a flag, delete, update etc a notification should show up to either confirm success or show an error.

All pages should share the same approach to showing notifications. Might be good to have a notification provider or something.

Being an official SDK for Nodejs , it makes sense to have it inside the main repo itself.

The SDK should be placed inside the folder: packages/sdk/nodejs

It should be a 100% Typescript SDK.

The search bar in the dashboard should be able to return results based on text based search.

Once the user clicks on the search bar, the Tailwind command palette should show up and allow the user to search.
https://tailwindui.com/components/application-ui/navigation/command-palettes

Build a SDK library for Go. The repo should be: https://github.com/switchfeat-com/switchfeat-go-sdk

Please refer to the sdk routes to build the sdk around it: https://github.com/switchfeat-com/switchfeat/blob/main/packages/api/src/routes/sdkRoutes.ts

this feature is partly implemented, it is going to need to be completed and tested.

A datetime condition should include the following checks:

"before" | "after" | "beforeOrAt" | "afterOrAt" | "equals" | "notEquals"

between a the given context (datetime) and the condition value.

The SdkService should be updated with a new condtion matcher to evaluate this condition.

Build a SDK library for .NET. The repo should be: https://github.com/switchfeat-com/switchfeat-dotnet-sdk

Please refer to the sdk routes to build the sdk around it: https://github.com/switchfeat-com/switchfeat/blob/main/packages/api/src/routes/sdkRoutes.ts