anthonypecchillo/bracegirdles

Greenfield Project!

Hack Reactor Alumni Network

A social media platform for building/maintaining relationships within the Reactor Core network.

---

HRAN provides a platform for leveraging your Hack Reactor/Reactor Core peer network to accelerate your growth as a software engineer. Build your own profile and link up with your fellow alumns to keep each other up to date on your job search status, current projects, and learning experiences. Contribute to the networks value by posting self-authored articles on industry experiences and technical discoveries. Consider this our own private LinkedIn, our fulcrum (if you will) to ease the burden of navigating our new journey.

Team

• Product Owner: Anthony Pecchillo
• Scrum Master: Jordan Medina
• Development Team Members: Maurice Okumu, Patrick Shen

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Using HRAN is simple! To get started:

Sign Up

From the HRAN landing page:

1. Click the sign up button to navigate to our registration page.

2. Provide your pertinent information in the registration form.

   • Upon submitting the form, you will be automatically logged in and redirected to the Main Feed.

Set Up Your Profile

3. Click settings to edit your profile.

   • Add a Bio
   • Add your Picture
   • Add links to your LinkedIn, GitHub, Twitter, etc.

4. Click Profile to see your updated profile.

Check Out the Feed

5. Click Feed to read the most recent posts from the Alumni Network.

6. Submit your first post!

Requirements

• Node v6.1.0
• Yarn v0.19.1
• Nodemon v1.11.0
• MySQL v5.7.17
  • To install MySQL, it is recommended that you use Homebrew.

NOTE: We use Yarn instead of NPM. A very useful NPM-to-Yarn cheatsheet can be found here.

Development

Installing Dependencies

All required dependencies are stored in the yarn.lock file in the root directory. At the command line from within the root directory, enter:

yarn

Transpiling React Codebase

Run the following at the command line once initially, and then again after making any changes to your front-end React code:

yarn build:dev

This is for builds during development. In order to build for production, simply run:

yarn build

Starting the Server

To start the server using Nodemon and continuously watch for any file changes, run the following at the command line:

yarn start

Begin Development

View the current project at localhost:3000. At this point, you're ready to start development!

Roadmap

View the project roadmap here.

Contributing

See CONTRIBUTING.md for contribution guidelines.