Latest Prototype Screenshots

Report a Bug · Request a Feature · Ask a Question

Table of Contents

• About
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Support
• Project assistance
• Contributing
  • Commiting Code
  • Branch naming & pull requests
• Authors & contributors
• Security
• License

---

About

People who struggle with executive dysfunction often have difficulty keeping track of dense information - especially in an academic setting. The #ADHD study group also found it challenging to coordinate and get help from the community when needed. To stay productive, we decided to address these issues.

Together, we designed a prototype that will allow us to track classes, assignments, and resources automatically. The app will also enable students to connect easily on Discord when help is needed.

Built With

• Next.js (Repo)
• React.js (Repo)
• Prisma (Repo)
• NextAuth.js (Repo)
• Mantine (Repo)
• Node.js
• MongoDB

Getting Started

Prerequisites

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.

Installation

To install the required packages & dependencies:

pnpm install

Environment Variables

• This will require that you setup a MongoDB database. We recommend using MongoDB Atlas because there's a free option.
• You will also need access to our Discord Developer Portal. For this, you can reach out @GarlandKey or @JoeKarow.
• Do not try to run the server locally until you have completed the MongoDB and Discord setup.

Copy .env.example in the root directory and name it .env

cp .env.example .env

Follow the instructions listed in the newly created .env.

Once complete, you'll need to seed the database with test data. Do this as follows:

pnpm db:seed
pnpm db:devseed

Usage

To start the development live server:

pnpm dev

If you need help with installation or setup, please reach out to @GarlandKey or @JoeKarow.

Roadmap

1. Minimum Viable Product
   • Account system
   • Welcome page
   • Classes page
   • Assignments page
2. Calendar page
3. Tasks page
4. Help Link system
5. Moderator Operation system

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

Support

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile

Project assistance

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, Hashnode, Medium or your personal blog.

Together, we can make thinkBig better!

Contributing

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!

Commiting Code

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.

Branch naming & pull requests

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.

Authors & contributors

The original setup of this repository is by 100Devs.

For a full list of all authors and contributors, see the contributors page.

Security

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.

License

This project is licensed under the GNU General Public License v3.

See LICENSE for more information.