Creating an easiest way to share your social media links!
View Demo »

Production · Staging · Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Installation
2. Built With
3. Roadmap
4. Contributing
5. License
6. Contributors

Getting Started

This is the instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/mashwishi/kohee.git

2. Install NPM packages

   npm install

3. Enter your ENV in .env or .env.local

   CLERK_JWT_KEY = "";
   CLERK_API_KEY = "";
   NEXT_PUBLIC_CLERK_FRONTEND_API = "";
   HASURA_ADMIN_SECRET = "";
   
   ENDPOINT_KEY_PROD = "";
   ENDPOINT_KEY_LOCAL = "";
   
   NEXT_PUBLIC_HASURA_PROJECT_ENDPOINT = "";
   NEXT_PUBLIC_HASURA_REST_API = "";
   NEXT_PUBLIC_HOSTNAME = "https://<yourdomainhere>";
   
   NEXT_PUBLIC_GOOGLEADS_CLIENT = IMGUR_CLIENT_ID = "";
   IMGUR_CLIENT_SECRET = "";
   
   GOOGLE_ANALYTICS_TRACKING_ID = "UA-";
   
   GEOAPIFY_URL = "";
   GEOAPIFY_KEY = "";

   Universal Analytics will no longer process new data in standard properties beginning July 1, 2023. The react-ga is now deprecated (12/18/2022) since it is still not July 1, 2023 I will keep this configuration and wait for react-ga updates while waiting for an alternative solution.

4. Run on local using npm run dev or on prod using npm run

Built With

This section list of major frameworks/libraries we used to our your project.

• 
• 
• 
• 
• 
• 

Roadmap

• Create a repo
• Deploy live/staging with vercel
• Kohee Landing page
• User Social Media Authentication
• User Security Settings
• User Links Settings
• User Customizations Settings
• Sharable profiles
• Follow System
• Kohee user dashboard
• User Discovery
• API Webhooks and Endpoints
• User Followers and Visits
• Front-End Enhancement
• User Analytics
• Progressive Website Application Feature
• QR Generator
• QR Scanner
• Ads to support the project
• Referral Program to earn more feature
• Release on Google Play Store for Android
• Release on App Store Store for iOS

See the open issues for a full list of proposed features (and known issues).

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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 GNU License. See LICENSE.txt for more information.

Contributors / Collaborators

@Mashwishi, @Exarus, @Aspect

Partners

Sponsors