By creating a space for neurodiverse education scheduling and resource sharing, we can provide our children with the tools and resources they need to thrive. This includes providing them with a single schedule where teachers, parents and medical professionals can collaborate on planning. Find information on therapies, social skills training, and educational resources tailored to unique, neurospicy needs. Raise awareness, empower individuals with Autism, and give back to the community. All donations go directly to the Autism Foundation.
To use NeuroSpace, simply visit us at our Heroku-deployed app: NeuroSpace. You will then be able to sign up, connect with other users, collaborate on your schedule, send direct messages and explore resources tailored to your special needs. You can donate directly to the Autism Foundation after signing up - simply click "Donate" and choose your amount!
Front-End: React framework, Vanilla CSS
Back-End: Node.js, Express, MongoDB, Mongoose, GraphQL, Apollo Server
Authentication & Authorization: JWT
Payment Integration: Stripe
Deployment: Heroku @ NeuroSpace
Additional Libraries: ESLint, fullCalendar
Contribution Guidelines
Thank you for considering contributing to our project! We welcome and appreciate your help. Please follow these guidelines to make the contribution process smooth and efficient for everyone involved.
- Code of Conduct
All contributors are expected to adhere to our Code of Conduct. By participating, you agree to maintain a respectful and inclusive environment.
- Prerequisites
- Familiarity with Git and GitHub
- Knowledge of JavaScript, MERN Stack
- Getting Started
Fork the repository by clicking the "Fork" button on the top right corner of the main repository page. Clone your forked repository to your local machine: git clone https://github.com/acst52/NeuroSpace.git Add the original repository as a remote to your local repository: git remote add upstream https://github.com/acst52/NeuroSpace.git
- Branching
Create a new branch for each feature or bug fix you work on. Use the following naming convention for branches:
For features: feature/short-feature-description For bug fixes: bugfix/short-bugfix-description
- Development Environment
To install necessary dependencies, run the following command:
npm i
- Commit Messages
Write clear and concise commit messages describing the changes made. Use the imperative mood.
- Submitting a Pull Request
Fetch the latest changes from the original repository: git fetch upstream Rebase your branch on the latest main branch: git rebase upstream/main Push your changes to your fork: git push origin your-branch-name Open a pull request on GitHub, providing a clear description of your changes and any additional context.
- Issue Reporting
Before reporting a bug or requesting a new feature, search the existing issues to avoid duplicates. Please use the following template to report your issue. It helps us understand your problem and reduce the time it takes to address it.
Issue Reporting Template
Title: A concise, descriptive title.
Description:
A clear and concise description of what the issue is, including what you were doing when you encountered the issue.
Steps to reproduce: 1., 2., 3.
Expected behavior:
A clear and concise description of what you expected to happen.
Actual behavior:
A clear and concise description of what actually happened.
Screenshots:
If applicable, add screenshots to help explain your problem.
Environment:
Relevant operating system, software and version information.
Additional context:
Add any other context about the problem here.
Remember, the more information you provide, the easier it is for us to verify and resolve the issue. Thank you for your contribution!
- Review Process
Pull requests will be reviewed by maintainers and/or other contributors. Address any requested changes and maintain a respectful and constructive tone during the review process.
- Contributor Recognition
Contributors will be recognized in the CONTRIBUTORS.md file and in the project's documentation.
- Communication
Join our {GitHub Discussion - coming soon} to ask questions and discuss the project.
Thank you for contributing! We look forward to working together to improve this project.
If you have any questions about this project, you can contact us. Please see CONTRIBUTORS.md for details or email us!
You can find more of our work at acst52 / teriannephillips / Jennyzzhh / MaximosSarmpas.