Skip to content

web-dev-carolina/club-site

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

543 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Web Dev Carolina's Website

This website aims to take advantage of the MEAN stack to showcase our organization's projects and community engagement. For styling, we are using bootstrap and our own custom CSS to create a personalized and interactive website.

Initial setup

Use npm to install dependencies (make sure you do so in the public directory and the functions directory).

npm install

In the off chance that does not work, you may also try...

npm update

You may also need the Angular CLI. You can install this by typing this command in the public directory.

npm install -g @angular/cli

Components

The website has been broken down into several major components that different group members have been assigned to develop. The app-root calls all of the following components at the moment:

├── landing
│   ├── login
│   ├── single-page
│   │   ├── about-us
│   │   ├── contact-us
│   │   ├── footer
│   │   ├── home
│   │   ├── project
│   │   ├── testimonial
│   │   └── upcoming-announcement
│   │       ├── announcement
│   │       └── upcoming-event
│   └── top-bar
└── logged-in
    │   ├── create
    │   ├── home-logged
    │   ├── inquiries
    │   ├── members
    │   ├── projects-logged
    └── └── top-bar-logged-in

Development Mode

To run the app make sure you're in the club-site directory then enter the following command in the terminal.

nodemon server

This will run your code on localhost:3000. Nodemon will automatically make the updates (to the backend) live when you save, so you don't have to restart your backend everytime you make a change.

If nodemon is giving you a command not found error... Run this command in the club-site directory.

sudo npm install -g --force nodemon

To get the frontend running, type the following command in the app directory.

ng serve --open

... or if you are working on the backend as well run this command in the app directory (or if you want to build and use the server to test for production).

ng build --watch

Production Mode

Run this command in the public directory to deploy the hosting.

firebase deploy

Run this command in the root directory to deploy the functions.

firebase deploy --only functions

Backend is deployed at the following url...

https://us-central1-home-c6ab1.cloudfunctions.net/app

Frontend is deploy at the following url...

https://webdevcarolina.com/

Testing (do in public folder)

Unit Tests

ng test

e2e Tests

ng e2e

The deployed version is contained on the 'Firebase' branch to ensure we always have a stable version of the code.

Contributors

  • Christian Nell (Project Lead)
  • Addison West (Frontend Lead)
  • Rushil Shah (Treasurer)
  • Tatiana Kelliher
  • Advaith Deo

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors