Skip to content
A Text Notification Service for San Jose Parks and Recreations Department for subscribed users.
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github/ISSUE_TEMPLATE
client
configurations
controllers
documentation
lib
middleware
models
routes
services
.env.example
.gitignore
README.md
index.js
package-lock.json
package.json

README.md

Text Notification Platform for San Jose Parks

📦 How to Set up

From scratch

Assuming your fork the project in a folder named "SJParks" on your Desktop.

cd ~/Desktop/SJParks
git checkout -b <NAME__OF_YOUR_BRANCH>
npm run setup // Install packages
npm run dev

Add .env in root folder with your personnal and private data

APP_SECRET=
CLIENT_PORT=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
CLOUDINARY_CLOUD_NAME=
MLAB_URI=
MONGODB_URI=
NODE_ENV=
SERVER_PORT=
TEST_MONGO_URL=
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TWILIO_NUMBER=

Client run on http://localhost:3000

Server run on http://localhost:5000

🎉 How to contribute

Into your branch

git remote add upstream git@github.com:Wolfy64/SJParks.git
git pull upstream development
// ... Do your work
npm run test
git push

Go to GitHub and Pull Request 🔗 your branch

If you want to check your tests of your build you can also signup to CircleCI 🔗 with your GitHub account

Other command

On root folder:

To install packages for both server and client npm run setup

To start server and client npm run dev

To start only the server npm run server

To start only the client npm run client

To run test into the client npm test

Demo: Admin Dashboard

Connect to: http://localhost:3000/login

User ID: test@test.com

Password: 123456

You can’t perform that action at this time.