Please make sure your Node.js version is newer than 8.12.0.
You can have multiple Node.js versions by using nvm
nvm install 8.12
Use avn for switching versions automatically according to .node-version.
yarn global add avn avn-nvm
avn setup
git clone git@github.com:efcsydney/efcsydney-roster.git
cd efcsydney-roster
yarn
cd client
yarn
cd ..
Download and install MySql server. Browse to (https://dev.mysql.com/downloads/mysql/) and download MySql community server and MySql Workbench.
Make sure that the root user password is leave as blank. If the root user password has been set, execute the following query to remove the password.
SET PASSWORD FOR root@localhost=PASSWORD('');
Once MySql server is installed and the root user is configured, execute the following command. Make sure the working folder is set to the project root directory.
yarn db-create // create database
yarn db-migrate // migrate database
You can use other sequelize utilities eg. node_modules/.bin/sequelize db:migrate:undo to revert migrations
To use different environment, please add environmental variable NODE_ENV=xxx, ie. NODE_ENV=test npm run db-create.
Since we may need to continue to update event data, we use a script instead of seeding tool to achieve this. This script can be run multiple times, and will used db/data/english-events.csv and db/data/chinese-events.csv as data source.
yarn db-update-events
You can setup your local settings by creating config/local.yaml. This will overwrite all other settings.
To test email, you can use your own email account and smtp provider, or use fake smtp providers like ethereal. Note that to make gmail work, you have to put it to a less secure setting.
First you will have to setup the test database
NODE_ENV=test yarn db-create // create database
NODE_ENV=test yarn db-migrate // migrate database
yarn test // will run unit test and integration test
yarn start
use test database in default: http://localhost:3000/
If you want to use production database: http://localhost:3000/?mock=false
create-react-app configures a Webpack development server to run on localhost:3000. This development server will bundle all static assets located under client/src/. All requests to localhost:3000 will serve client/index.html which will include Webpack's bundle.js.
To prevent any issues with CORS, the user's browser will communicate exclusively with the Webpack development server.
Inside Client.js, we use Fetch to make a request to the API:
// Inside Client.js
return fetch(`/api/food?q=${query}`, {
// ...
})This request is made to localhost:3000, the Webpack dev server. Webpack will infer that this request is actually intended for our API server. We specify in package.json that we would like Webpack to proxy API requests to localhost:3001:
// Inside client/package.json
"proxy": "http://localhost:3001/",This handy features is provided for us by create-react-app.
Therefore, the user's browser makes a request to Webpack at localhost:3000 which then proxies the request to our API server at localhost:3001:
This setup provides two advantages:
- If the user's browser tried to request
localhost:3001directly, we'd run into issues with CORS. - The API URL in development matches that in production. You don't have to do something like this:
// Example API base URL determination in Client.js
const apiBaseUrl = process.env.NODE_ENV === 'development' ? 'localhost:3001' : '/'This setup uses concurrently for process management. Executing npm start instructs concurrently to boot both the Webpack dev server and the API server.
Deploy to QA server hostname: http://demo-roster.efcsydney.org
yarn deploy:qa
Deploy to Production server http://roster.efcsydney.org
yarn deploy:prod
Backup database
yarn db-backup
A new sql dump file will be created in the BACKUP directory(see config/default.yml). The file conforms to the following naming convension:
<database_schema_name>_<YYYYMMDD>.sql
e.g. efcRosterQa_20180101.sql
Restore
yarn db-restore <YYYYMMDD>
An argument is required to specify the database version.
e.g.
yarn db-restore 20180101