View Live | Report Bug | Request Feature
Monorepo containing all services running under the *.mstacm.org domains built with TypeScript, Apollo GraphQL, and Docker.
*.mstacm.org hopes to automate all of the manual task's ACM has performed primarily by hand including:
- Events - Automatically advertise events via email, text, or app notifications; allow users to check-in to events; and pay for event registration electronically.
- Dues - Collect dues and provide advanced metrics on when dues were payed.
Future work hopes to expand upon these primary principles to make how companies, ACM members, and students interact with ACM as an organization more enjoyable and efficient.
To get a local copy up and running follow these simple steps.
- Clone the mstacm.org repository using Git Bash:
git clone https://github.com/sigdotcom/mstacm.org.git
Since this repository is a monorepo, the best way to use its various functionality is by exploring the directories containing each project.
Find these projects in the apps
directory, where we store all of the
applications we have built for our web services
Each project will contain its own installation / setup instructions to follow in their respective README.md
.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
We use a pattern known as Github Flow. Click that link to learn more.
One-time set up:
- Ask the Chair of ACM Web to add you to the sigdotcom organization
- Clone the mstacm.org repository
git clone https://github.com/sigdotcom/mstacm.org.git
Every feature:
-
Update your local master branch
git switch master # "git checkout master" if git < 2.23 git pull master
-
Create your branch
git switch -c feature/<feature-name>
where
<feature-name>
is replaced with a short description of your feature (ex.admin-permission-tool
for a feature adding a new tool to admin-web)Name your commits with
feature/
orhotfix/
at the beginning depending on the content of the branch. (ex.feature/new-icons
,hotfix/icon-render-glitch
) -
Add and commit your Changes
git add file1 file2 ... # only add relevant files git commit -m 'Add some great specific and well described features' # After the "-m" goes the commit message
Read this article about good commit messages to maintain good quality commits
-
Push to the remote branch
git push origin feature/<feature-name>
-
Grab a new issue to work on and start from the top!
-
Fork the mstacm.org repository
-
Create your branch
git switch -c feature/<feature-name>
where is replaced with a short description of your feature (ex. admin-permission-tool for a feature adding a new tool to admin-web)
Name your commits with
feature/
orhotfix/
at the beginning depending on the content of the branch. (ex.feature/new-icons
,hotfix/icon-render-glitch
) -
Add and commit your Changes
git add file1 file2 ... # only add relevant files git commit -m 'Add some great specific and well described features' # After the "-m" goes the commit message
Read this article about good commit messages to maintain good quality commits
-
Push to the remote branch
git push origin feature/<feature-name>
-
Grab a new issue to work on and start from the top!
Distributed under the MPL-2.0 License. See LICENSE
for more information.
ACM Web - [email protected]
Project Link: https://github.com/sigdotcom/mstacm.org
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!