search

uclasoles / UCLA-SOLES-website

This is the code for UCLA SOLES
MIT License
3 stars 1 forks source link

readme

SOLES@UCLA Website

David GitHub issues

This repository contains the source code of the Society of Latino Engineers @ UCLA website. The project is owned by SOLES@UCLA's Technical Chair email account, uclasoles.technicalchair@gmail.com . Currently, the lead organizer of this project is Kyle Romero, kyleromero98@gmail.com .

Feedback

All feedback, feature requests, or bugs should be communicated through Issues. Please see the Issues tab above.

Installation

No installation is required to use this site. The currently hosted version of the website can be found here. Please note that the website is under construction and is not considered functional at this time.

Quick Set-Up

Before contributing to this repository and for more detailed set-up information, please see the Contributing page of our Wiki. The following is a quick set-up guide for this project:

> git clone git@github.com:uclasoles/UCLA-SOLES-website.git soles-site-dev
> cd soles-site-dev
> npm install

After running npm install, you will need to obtain a copy of our Firebase development credentials before you can host a local development version of the website. These credentials are obtainable by sending an email and name to kyleromero98@gmail.com . We may use this information to verify your identity as a SOLES member.

Once obtaining your development credentials, you will be able to host a local version of the SOLES website by running npm start. Then, the website should be viewable at http://localhost:3000 .

Release History

Current Organizer

Kyle Romero - @k_rommie - kyleromero98@gmail.com

https://github.com/kyleromero98

Distributed under the MIT License. See LICENSE for more information.

Below this line is legacy information that will be moved to the Wiki and Contributing section of the project when that is written

Hosting the Production Version of the Site with Firebase

When you are ready to push a production build of the site, one can do so with the following commands:

  1. git clone git@github.com:/uclasoles/UCLA-SOLES-website.git soles-site
  2. cd soles-site
  3. npm install
  4. Copy the .env file containing the site's Firebase credentials from the uclasoles.technicalchair@gmail.com Google Drive to the soles-site directory. Optional: Check to ensure that you can locally host the site by running 'npm start'. Additionally, see the notes in the first section about copying .env from the Google Drive to a Windows machine.
  5. npm run build
  6. firebase init
  7. Select Database, Functions, Hosting, and Storage then press .
  8. Select soles-website to associate this upload with the production project.
  9. Accept default Database Setup.
  10. Choose Javascript for Cloud Functions.
  11. Accept default for using ESLint.
  12. Accept default for installing dependencies with npm.
  13. Enter build for the public directory.
  14. Accept defualt, N, for single-page app.
  15. Accept default, N, for NOT overwriting build/index.html.
  16. Accept default option for Storage Rules.
  17. firebase deploy
  18. The site should now be available at https://soles-website-dev.firebaseapp.com

References

The following tutorial was used to create the first version of the site: