cvu-portfolio-app

Web app for CVU students to arrange Drive files by learning standards

Environment Configuration

Install Dependencies

Start by installing the required Node dependencies with

$ npm install

Add OAuth & Firebase Credentials

Create a .env.local file and add OAuth/Firebase credentials like so:

NEXT_PUBLIC_API_KEY=...
NEXT_PUBLIC_OAUTH_CLIENT_ID=...

OAUTH_CLIENT_SECRET=...

NEXT_PUBLIC_FIREBASE_API_KEY=...
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=...
NEXT_PUBLIC_FIREBASE_PROJECT_ID=...
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=...
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=...
NEXT_PUBLIC_FIREBASE_APP_ID=...

Running

Development

To run this app in development mode, simply use

$ npm run dev -p <PORT>

If the -p flag is omitted, Next will run on port 3000.

Using Firebase Emulators

To use local Firebase emulators instead of connecting to the cloud, navigate to the ./gcloud/firebase folder and install the cvu-portfolio-app-firebase project:

$ cd gcloud/firebase
$ git init
$ git remote add origin https://github.com/isaackrementsov/cvu-portfolio-app-firebase
$ git pull origin master

Then, globally install the Firebase module with npm.

$ npm i -g firebase

Also, make sure to install Java if you haven't already.

You should now be able to start the Firebase emulators (from the ./gcloud/firebase directory) with

$ firebase emulators:start

To configure this app to use the emulators, simply add the following lines to .env.local and use the npm run dev command.

NEXT_PUBLIC_NODE_ENV=development
FIRESTORE_EMULATOR_HOST=localhost:8080

Production

To run this app in a production environment, first build the project with

$ npm run build

Then, start the server by running

$ npm run start

Google Cloud Configuration

For additional information on configuring Google Cloud Services (OAuth, Drive API, Firebase), see the Steps for Deployment document.

Additional Info For App Deploy

Set up Firebase Firestore db
- Configure permissions
You need to download the service account private key from firebase and set is as the environment variable FIREBASE_SERVICE_ACCOUNT (strip out newlines, leave off surrounding quotes)
Set up and configure Google Oauth via the Google Cloud developer console: https://console.cloud.google.com/
- You need an Oauth 2.0 Client and a Service Account (Firebase will set up your key for you automatically, I already had one in there after setting up Firestore, but you'll have to set up the Oauth stuff yourself)
- Make sure Oauth client has deployment urls set up properly
  - Note: Sometimes this means you have to clear browser cache (i.e. for incorrect js origin error or redirect_uri changes)
Enable the Google Drive API for your app in the Google Cloud developer console: https://console.cloud.google.com/
Enable the Picker API for your app in the Google Cloud developer console: https://console.cloud.google.com/

davertron / cvu-portfolio-app

readme