4.um

Personalized, interactive forum for software developers.

Team

• Ali Elgiadi

• He Liu

• Michael Sermersheim

• Oliver Ullman

Table of Contents

1. Usage

2. Requirements

3. Development

1. Installing Dependencies

2. Tasks

4. Roadmap

5. Contributing

Git Workflow

1. Type: git remote add upstream https://github.com/Magenta-Elephants/Magenta-Elephants

2. (ensure you are on master branch) type: git checkout master

3. (Sync local master with org’s master) type: git pull --rebase upstream master

4. Create a feature branch, type: git checkout -b <name_of_branch>

5. BEFORE SUBMITTING YOUR NEW CHANGES:

1. git add .

2. git commit

3. git pull --rebase upstream master

6. git push origin <name_of_branch>

7. PULL REQUEST WITH GITHUB

8. Team member reviews code and decides whether to merge or not

9. IF ACCEPTED/MERGED

10. (Switch back to master) type: git checkout master

11. (Delete local branch) type: git branch -D <name_of_branch>

12. type: git pull --rebase upstream master

13. git push origin master

Usage

Where software developers of all skill levels and specialties can come together for trustworthy guidance and positive contributions to their community's growth.

Requirements

• React

• Express

• MySql

• Socket

Getting Started

• NPM install

• NPM run react-dev

• NPM run server-dev

• From the root directory run node populateDB.js

• If necessary also run npm run test to clear and repopulate databases

• Go to localhost:3000

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.