Skip to content

Latest commit

 

History

History
159 lines (95 loc) · 5.75 KB

README.md

File metadata and controls

159 lines (95 loc) · 5.75 KB

LPU Student Organizations

Organizations - of the students, by the students, for the students!

Logo

Problem Statement:

With a plethora of Developer Communities in College, students have a hard time finding basic information about these communities on their respective websites.

Problem Solution:

This project offers a ‘Website for students to find all the basic information about Developer Communities in their College in one place’. Currently, the app is limited to Lovely Professional University, Punjab. The project scope is to offer our functionalities to other universities and communities over time.

Best features:

  • Implemented Voice Control Feature (Alpha)

Angular application File / Folder Architecture summary:

  • package.json: consists of Node/NPM library/package/module dependencies for application development
  • node_modues - folder consists of all installed packages
  • src/main.ts - entry point to angular application. src/index.html
  • app/app.module.ts - route module of application
  • app/app.component.ts - route component of application
  • ng serve / npm start -> main.ts (index.html) -> app.module.ts -> app.component.ts -> (app.component.html + css)

Functionality & Concepts used :

The Website has a very simple and interactive interface which helps the users select their route flight and find its prices. Following are few Web and Firebase concepts used to achieve the functionalities in website :

  • Components : to add header, footer, search feature in the website. Header and footer components are reused in the website.
  • Directives : Define how the view components are placed. It also describes the overall structure of the website components.
  • Databinding : Show the synchronisation between model and view. It populates the websites after mapping the model and view of each website page.
  • Firebase Auth : To authenticate users to the website.
  • Firebase Firestore database : To add Student organisation details/policies.
  • Firebase Hosting - To host the website.

Application Link & Future Scope :

The app is currently in the Alpha testing phase for #vertos of Lovely Professional University, You can access the app : https://so-lpu.web.app/.

  https://so-lpu.web.app/

Once the website is fully tested and functional inside campus, we will plan it to scale it up by implementing various Google Developer Services to this app idea and collaborate across globe to create a production ready solution. We aim that by next year students across 🌐 will use this platform to list their College/University Student Clubs / Student Developer Community.

Development server

To deploy this project run

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

  ng serve -o

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

  ng generate component component-name

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

  ng build

Running unit tests

Run ng test to execute the unit tests via Karma.

  ng test

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

  ng e2e

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Screenshots

Home Page

Signup Page

Signin Page

Home Page 2

About Page

About Page 2

Policies

Contact Page

Run Locally

Clone the project

  git clone https://github.com/gdsclpu/LPU-Student-Organizations.git

Go to the project directory

  cd LPU-Student-Organizations

Install dependencies

  npm install

Start the server

  npm run serve -o

Support

For support, email [email protected] or join our Slack channel https://s.gdsclpu.tech/slack.

Authors

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.