Skip to content

software-students-fall2021/project-setup-linkednyu

Repository files navigation

LinkedNYU

Live Link

Note: This app is designed for mobile users, adjust browser size for better experience.

Product Vision

Providing fast and convenient experience for NYU student to directly get access to course sources and solve their confusions.

Description

LinkedNYU provides a platform for students from the same course to find their classmates, discuss with each other and socialize. Previous students from this course can share their experience and help others decide whether to take this course or not.

In order to provide most convenient and satisfying experience for NYU students, LinkedNYU is supposed to contain following basic functions:

  • Viewing:

    Students can view other's posts and comment.

    Logged in students can see new updates in the channels they joinned.

  • Searching:

    Powerful searching tools that will enable students to find their courses based on the course number, name, name of Professor;

    Searching function will present student with relative channels and posts.

    Students can join course channel to keep updated.

  • Posting:

    Students can post discussions in their channels.

    Posts will be shared to other students, who can also join the discussion by commenting their own thoughts.

Team Members

@Comf0rTS1997
@AnastasiaYe
@princeampofo
@Willis1118
@Azanah

Instructions for Build and Test Locally

Run the server

Make sure you clone the repo. Inside your local repo, using terminal.
Go to back end folder

cd back-end 

Install dependencies

npm install

Create a .env file with content that allow you to connect to database

CONNECTION_URL = <your link here>
SECRET_TOKEN = secretkey

Start the server
(there should be a browser windows shows up and tells you the server is running locally)

npm run devStart

Run the test
(only for development purpose, this is not required for running the app)

npm run test

See test code coverage
(only for development purpose, this is not required for running the app)

npm run coverage

Run Front-end

( If you are inside back-end folder, make sure to go back first by typing cd - )

Go to front end folder

cd front-end

Install dependencies

npm install

Run front end program

npm start

Now you should see a browser window running the app.

Note: This app is designed for mobile users, adjust browser size for better experience.

Prototype

App Map and Wireframes

Color Theme

We choose NYU purple to be the main color of our theme.
color

Sprint Planning

Sprint 0

Product Owner @Willis1118
Scrum Master @AnastasiaYe

Sprint 1

Product Owner @Willis1118
Scrum Master @AnastasiaYe

Sprint 2

Product Owner @princeampofo
Srum Master @Comf0rTS1997

Sprint 3

Product Owner @princeampofo
Scrum Master @AnastasiaYe

Sprint 4

Product Owner @princeampofo
Scrum Master @Comf0rTS1997

Contributing

Anyone is welcome to dive in! Feel free to Open an issue or Pull Request.

In terms of more detailed contributing rule, read through CONTRIBUTING.md.

References

About

project-setup-linkednyu created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages