From b5fae1c79a46bc58542ceeb66f8b9ffecd918b33 Mon Sep 17 00:00:00 2001 From: Daniel Molzahn Date: Thu, 25 Apr 2019 21:19:25 -0400 Subject: [PATCH 1/3] Updated Useful Information --- Useful_Information/Code_of_Conduct.md | 19 ++-- .../Detailed_Installation_and_Running.md | 100 +++++++++++++++++- Useful_Information/Get_Involved.md | 8 +- Useful_Information/How_To_Contribute.md | 4 +- 4 files changed, 114 insertions(+), 17 deletions(-) diff --git a/Useful_Information/Code_of_Conduct.md b/Useful_Information/Code_of_Conduct.md index 7ee5d8a..2358cd5 100644 --- a/Useful_Information/Code_of_Conduct.md +++ b/Useful_Information/Code_of_Conduct.md @@ -1,18 +1,15 @@ # Schedj Contributor Code of Conduct ## Our Pledge -We will foster an environment of open collaboration, with active communication and participation. -Our community will be harassment-free, and our code will be accessable and usable to all individuals, -regardless of age, disability, education, socio-economic status, religion, race, nationality, -appearance, or gender or sexual identity and orientation. +We will foster an environment of open collaboration, with active communication and participation. Our community will be harassment-free, and our code will be accessable and usable to all individuals, regardless of age, disability, education, socio-economic status, religion, race, nationality, appearance, or gender or sexual identity and orientation. ## Our Standards * Use welcoming and non-exclusionary language. * Be respect of differing views and experiences. -* Openly give and receive constructive criticism. +* Openly give and recieve constructive criticism * Put the good of the project first. -# Examples of improper behavior +## Examples of improper behavior * Unwanted sexualized language or advances. * Actions that would be considered inappropriate or unprofessional. * Trolling or targeting individuals for their personal views. @@ -21,16 +18,16 @@ appearance, or gender or sexual identity and orientation. Use your head and try to remember that there is a person on the other side of your computer screen. ## Our Responsibilities -Administrators are responsible for judging +Administrators are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. -//TODO FILL OUT THIS SECTION +Administrators have the right and responsibility to remove or edit any contributions that do not align with this Code of Conduct, as well as remove/ban any contributors for any unacceptable behavior. ## Scope -This CoC is applicable in all project spaces, discussion boards, or community events; As well as -in any locations that you represent the project or its community, such as social media sites. +This CoC is applicable in all project spaces, discussion boards, or community events; As well as in any locations that you represent the project or its community, such as social media sites. ## Enforcement +Contributors with serious malicious intent will be revoked of any privileges and removed from the project immediately. Any personal disputes can be reported to a project administrator, who will then take disciplinary action while keeping the reporter anonymous. -//TODO FILL OUT THIS SECTION +First time offenders with minor offenses will be issued a warning, but continued misbehavior could result in their removal from the project. diff --git a/Useful_Information/Detailed_Installation_and_Running.md b/Useful_Information/Detailed_Installation_and_Running.md index ba3ce1b..1416f03 100644 --- a/Useful_Information/Detailed_Installation_and_Running.md +++ b/Useful_Information/Detailed_Installation_and_Running.md @@ -1,3 +1,99 @@ -# Detailed Installation +# Schedj Install Guide -//TODO FILL OUT THIS SECTION \ No newline at end of file +## Step 1: Install npm + +### Ubuntu + +[Install guide for Ubuntu 18.0.4](https://github.com/nodesource/distributions/blob/master/README.md) + +```sh +curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -sudo apt-get install -y nodejs +``` + +### Mac + +[Install guide for Mac OSX](https://treehouse.github.io/installation-guides/mac/node-mac.html) + +If you do not already have Homebrew installed, install [Homebrew](https://treehouse.github.io/installation-guides/mac/homebrew). Then type: + +```sh +brew update +brew install node +``` + +To test Node and npm installation, these commands will show the versions if you've installed properly: + +```sh +node -v +npm -v +``` + + +## Step 2: Install Expo + +### On Ubuntu and Mac + +[Expo install guide](https://docs.expo.io/versions/latest/introduction/installation/) + +```sh +npm install -g expo-cli +``` + +### On your Android or iOS device + +[Expo for Android](https://play.google.com/store/apps/details?id=host.exp.exponent&hl=en_US) + +[Expo for iOS](https://itunes.apple.com/us/app/expo-client/id982107779?mt=8) + + +## Step 3: Clone git repositories + +### Back end + +```sh +git clone https://github.com/Schedj/schedj-backend.git +``` + +### Front end + +```sh +git clone https://github.com/Schedj/schedj-frontend.git +``` + + +## Step 4: CD to directories and install npm + +Open two terminals simultaneously. + +In back end terminal: + +```sh +cd YOURPATH/schedj-backend/ +npm install +``` +In front end terminal: + +```sh +cd YOURPATH/schedj-frontend/ +npm install +``` + + +## Step 5: Run front and back end + +In back end terminal: +```sh +npm start +``` +In front end terminal: +```sh +npm start +``` + +On your mobile device: + +* Scan the QR code available on the front end terminal, or on at http://localhost:19002/ + +* The app should now be running in your mobile device + +* If you're on Mac, you can also run the app on your computer via Xcode Simulator diff --git a/Useful_Information/Get_Involved.md b/Useful_Information/Get_Involved.md index b0348ec..2b744aa 100644 --- a/Useful_Information/Get_Involved.md +++ b/Useful_Information/Get_Involved.md @@ -9,16 +9,18 @@ ## Check out our Project Proposal * https://docs.google.com/document/d/1wB8WGdqz8KdQQk5ZeuHmsyHPLj7jTbd795EhKfUYPfY +## Check out our website +* http://schedj.com ## Our Team -# Project Lead, Senior Programmer +## Project Lead, Senior Programmer * Chris Vanderloo -# Core Contributors +## Core Contributors * Alan Joy * Kevin Roughan -# New Contributors +## New Contributors * Gregory Saini * Daniel Molzahn \ No newline at end of file diff --git a/Useful_Information/How_To_Contribute.md b/Useful_Information/How_To_Contribute.md index 64f2b62..489292e 100644 --- a/Useful_Information/How_To_Contribute.md +++ b/Useful_Information/How_To_Contribute.md @@ -1,3 +1,5 @@ # How to Contribute -Create a fork of the repository. This will add a copy of the repo to your user account. Create a branch off of master in your repository, titled appropriately with the name of the feature/fix you are trying to implement. Once it has been coded and added to your repo, attempt a merge in your repo and test that everything works. Then, create an upstream pull request to the original repository for administrators to test and approve. \ No newline at end of file +1. Create a fork of the repository. This will add a copy of the repo to your user account. +2. Create a branch off of master in your repository, titled appropriately with the name of the feature/fix you are trying to implement. +3. Once it has been coded and added to your repo, attempt a merge in your repo and test that everything works. Then, create an upstream pull request to the original repository for administrators to test and approve. \ No newline at end of file -- 2.51.2 From 406fa14802c46837153f34ebcdffd3c27904391e Mon Sep 17 00:00:00 2001 From: Daniel Molzahn Date: Thu, 25 Apr 2019 21:21:57 -0400 Subject: [PATCH 2/3] Updated Useful Information --- Useful_Information/Code_of_Conduct.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Useful_Information/Code_of_Conduct.md b/Useful_Information/Code_of_Conduct.md index 2358cd5..43e1453 100644 --- a/Useful_Information/Code_of_Conduct.md +++ b/Useful_Information/Code_of_Conduct.md @@ -6,7 +6,7 @@ We will foster an environment of open collaboration, with active communication a ## Our Standards * Use welcoming and non-exclusionary language. * Be respect of differing views and experiences. -* Openly give and recieve constructive criticism +* Openly give and receive constructive criticism * Put the good of the project first. ## Examples of improper behavior -- 2.51.2 From 0d77efc475af486a625910cde1b20ad2a61c4347 Mon Sep 17 00:00:00 2001 From: Daniel Molzahn Date: Thu, 25 Apr 2019 21:24:09 -0400 Subject: [PATCH 3/3] Updated Useful Information --- Useful_Information/Code_of_Conduct.md | 2 +- Useful_Information/Get_Involved.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Useful_Information/Code_of_Conduct.md b/Useful_Information/Code_of_Conduct.md index 43e1453..bb701fc 100644 --- a/Useful_Information/Code_of_Conduct.md +++ b/Useful_Information/Code_of_Conduct.md @@ -6,7 +6,7 @@ We will foster an environment of open collaboration, with active communication a ## Our Standards * Use welcoming and non-exclusionary language. * Be respect of differing views and experiences. -* Openly give and receive constructive criticism +* Openly give and receive constructive criticism. * Put the good of the project first. ## Examples of improper behavior diff --git a/Useful_Information/Get_Involved.md b/Useful_Information/Get_Involved.md index 2b744aa..d2a289d 100644 --- a/Useful_Information/Get_Involved.md +++ b/Useful_Information/Get_Involved.md @@ -1,3 +1,5 @@ +# Where to Find Us + ## Join one of our chat rooms * https://chat.rcos.io/rcos/channels/schedj * https://discord.gg/7a7EpAB @@ -12,7 +14,7 @@ ## Check out our website * http://schedj.com -## Our Team +# Our Team ## Project Lead, Senior Programmer * Chris Vanderloo -- 2.51.2