The app generates a wide variety of cannabis strains for users to try, with detailed information on each strain's effects and properties. Users can also create and save their own personal collection of strains they've tried, keeping track of their favorites and discovering new ones.
![Logo](/Piyush-Bhor/StrainQuest/raw/master/public/images/logo-color.png)
Welcome to StrainQuest, the app that takes your cannabis journey to a whole new level of fun and exploration. Discover, collect, and enjoy an incredible variety of strains tailored just for you!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
StrainQuest is a fun game, that suggets you new and random cannabis strains to discover and try. You can collect these strain, search for the ones you have already tried and add them to your collection. It's a pokedex for weed!
Here are its features:
- Get new cannabis strains and their info.
- Search for a specific strain.
- Add strains you have tried to your collection.
Of course, this project is still ongoing and there are more features that will be added.
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
NPM is required to install dependencies for the project.
- npm
npm install npm@latest -g
The following steps will help you get started.
- Get a free Strain API Key from Rapid Api: Rapid API
- Create a free account on Auth0 and get Auth0 keys: Auth0
- Get connection string from MongoDB Atlas: MongoDB Atlas
- Clone the repo
git clone https://github.com/Piyush-Bhor/StrainQuest.git
- Install NPM packages
npm install
- Create a .env file with the following data:
CONNECTIONSTRING="Your mongodb connection string" SECRET="A randomly string" APIKEY="Your API key from Strain API" AUTH0_CLIENT_ID="Your AuthO Client ID" AUTH0_CLIENT_SECRET="Your AuthO Client Secret" AUTH0_ISSUER_BASE_URL="Your AuthO Issuer base url" REDIRECT_URI=http://localhost:8080/callback BASE_URL=http://localhost:8080
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Add Auth0
- Create README
- Create a Cannabis Strain API to replace the current API
- Suggest cannabis strains to users based on their preferences using ML
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Piyush Bhor - @LinkedIn - piyushbhor22@gmail.com
Project Link: https://github.com/Piyush-Bhor/StrainQuest
Some of the websites that helped me create this project.