Table of Contents
[?] Provide general information about your project here. What problem does it (intend to) solve? What is the purpose of your project? Why did you undertake it? You don't have to answer all the questions -- just the ones relevant to your project.
[?] Please provide the technologies that are used in the project.
This repo requires the use of pnpm
. To install, run the command:
npm -g install pnpm
or follow the instructions on pnpm's installation page.
If you are using VS Code, the think-big.code-workspace
file will suggest some extensions to use along with this development environment and break out the folder structure based on components.
To install the required packages & dependencies, run
pnpm install
Run
pnpm dev
to start the development live server.
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
[?] Provide additional ways to contact the project maintainer/maintainers.
Reach out to the maintainer at one of the following places:
- GitHub Discussions
- Contact options listed on this GitHub profile
If you want to say thank you or/and support active development of ThinkBIG:
- Add a GitHub Star to the project.
- Tweet about the ThinkBIG.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make ThinkBIG better!
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
This repo has a hook workflow to assist in the generation of Conventional Commits. When you wish to commit, please run the git commit
command from the terminal and not the GUI. You will be prompted for information to build the commit. After you complete the prompts, the commit message will be opened in the designated editor in your git
settings for you to preview before the code is committed.
If you don't want to constantly get stuck in vi
hell, follow these instructions to change the default editor that git
uses.
This repo is set up to not allow any commits to be pushed directly to the main
or develop
branches.
Create a new branch using the format YourUserName/very-short-description
.
When you're ready to submit a pull request, you will want to merge it in to develop
. Ideally, this pull request will correspond with one or more Issues.
We will submit pull requests from develop
to main
when we have enough meaningful changes committed.
The original setup of this repository is by 100Devs.
For a full list of all authors and contributors, see the contributors page.
ThinkBIG follows good practices of security, but 100% security cannot be assured. ThinkBIG is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the GNU General Public License v3.
See LICENSE for more information.
[?] If your work was funded by any organization or institution, acknowledge their support here. In addition, if your work relies on other software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.