Skip to content
The Voluntarily Platform
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode test coverage 100% Apr 28, 2019
__tests__ Refactored Filtering of ArchivedOpportunities and updated test Jul 17, 2019
assets volunteer home page Jun 5, 2019
components Merge branch 'master' into story/VP-367/activities-vertical-menu Jul 17, 2019
config prod is now alpha.voluntarily.nz Jul 3, 2019
docs remove redundant test Jul 2, 2019
hocs emergency fix Jul 14, 2019
lang add language changes Jul 16, 2019
lib [VP-379] Changing all instances of ArchivedOpportunitys to ArchivedOp… Jul 15, 2019
pages Merge branch 'master' into task/VP-393/Refactor-filtering-archived-op… Jul 17, 2019
server [VP-379] Changing all instances of ArchivedOpportunitys to ArchivedOp… Jul 15, 2019
static action card initial work Jun 19, 2019
x Send valid idToken Cookie Jul 12, 2019
.babelrc Added Auth0 authentication Apr 29, 2019
.cirrus.yml move to voluntarily.nz Jul 3, 2019
.dockerignore another variant May 23, 2019
.editorconfig fix standard js formatting Apr 27, 2019
.gitignore VP-207 fixing bug ensureSanitised() add undefined Jun 12, 2019
CODE_OF_CONDUCT.md fix standard js formatting Apr 27, 2019
CONTRIBUTING.md Create CONTRIBUTING.md May 14, 2019
CONTRIBUTORS Merge branch 'master' into VP-82 Jul 13, 2019
Dockerfile move to voluntarily.nz Jul 3, 2019
Dockerfile-test put mongo in image May 23, 2019
LICENSE Initial commit Apr 26, 2019
README.md Corrected instructions for docker-compose up Jul 18, 2019
docker-compose-alpha.yml APP_URL in prod is https Jun 1, 2019
docker-compose-ecs-atlas.yml APP_URL in prod is https Jun 1, 2019
docker-compose-localmongo.yml update now config and dockerfile May 2, 2019
docker-compose-prod.yml remove heroku ref in appUrl, prod docker-compose May 7, 2019
docker-compose.yml VP-111: Use correct env var for mongo URL May 6, 2019
next.config.js tests and examples Apr 28, 2019
nodemon.json Docker dev build May 1, 2019
package-lock.json Merge branch 'master' into story/VP-367/activities-vertical-menu Jul 17, 2019
package.json Update minor releases in packages Jul 16, 2019
vly2.code-workspace responsive fixes for hero (landing page) component May 15, 2019
xtravis.yml move travis out for now May 22, 2019

README.md

vly2

Gitter Build Status codecov License: MPL 2.0

Support education and innovation in New Zealand Schools with industry experts and volunteers in the classrooms

How to join the Voluntari.ly community

You don't need permission to help - its open.

This is an open source project and you are welcome to contribute at any level you feel comfortable. Find out more about the project at the Website and then...

  1. Say hi or ask questions in the gitter chat room above
  2. email team@voluntari.ly to tell us about yourself
  3. Start Reading documentation
  4. Build the code - below
  5. Add yourself to the CONTRIBUTORS file, check it in and send us a pull request - see this ticket VP-82
  6. Come along to a Drop in Wednesday Afternoon or after work social at our Auckland office
  7. Come along to one of our developer events - see http://voluntari.ly for the latest details.

How to build it

Voluntari.ly is based on the MERN (MongoDB, Express, React+Redux, Node) software stack but also uses next.js to keep things clean and simple.

and everything should work out of the box. There are two choices:

  1. install NodeJS and MongoDB and run locally.
  2. install Docker and run in a container.

Install NodeJS and MongoDB and run locally.

Prerequisites

You will need:

  • git You may already have it. Verify with git --version

  • nodejs. Verify this with node -v which should return a current version. e.g. v11.12.0

You will also need to be connected to the Internet and be prepared for some downloads. (sometimes corporate firewalls make this difficult - go get a coffee and use theirs.)

  • MongoDB or setup a free account in the cloud - but if you do this you will need to change the MONGO_URL=mongodb://localhost:27017/vly-test connection string in your environment or in package.json to point at your cloud URL.

For mac users brew install mongodb should be all you need to do.

  • start the mongodb service

For mac users: mongod

For windows users: Run command prompt as adminstrator, then run net start mongodb

Get the Voluntari.ly source code

git clone https://github.com/voluntarily/vly2.git
cd vly2
npm install

npm install may take several minutes as it pulls in all the dependent packages.

Available Commands

  1. npm run dev - starts the development server with hot reloading enabled

  2. npm run build - bundles the code

  3. npm run test - start the test runner

  4. npm run start - runs production server

  5. npm run check-coverage - generates test coverage report

  6. npm run lint - runs standard to check for lint errors ( npm run fix to fix lint errors )

Once you see the message "Voluntari.ly is running on port: 3122! Be Awesome!" then you can open your browser at http://localhost:3122.

If you see the message "Please make sure Mongodb is installed and running!" then go back and start mongod.

Press control+C to exit the node application.

Install Docker and run in a container.

You can use this option if you quickly want to see what the application looks like.

You will need:

Get the source code

git clone https://github.com/voluntarily/vly2.git
cd vly2
npm install

Start the Containers

docker-compose up -d --build

Note this may take a few minutes the first time you run it as it will download some images. Also once the command returns the services are still starting up so it will be a minute before you can visit the webpage.

You are in.

You will now be able to see the voluntari.ly application (if not then ask for help on our Gitter channel.

Stopping

To halt the containers run:

docker-compose down

More information at Using Docker and Docker Compose

You can’t perform that action at this time.