Welcome to Poodl! Find our application at https://poodl.herokuapp.com/. Read our wiki to learn more.
Project Presentation Slides are available here.
Development: poodl-dev.herokuapp.com
Production: poodl.herokuapp.com
Please read our development documentation before starting to develop for our project.
If you are not sure if you do, type yarn -v
, node -v
,
and npm -v
, and it will either say command not found
or tell you a version number.
If any of the above are not installed, using homebrew,
type brew install yarn
Installing yarn will also install node and npm
or, if yarn is installed without node or npm,
brew install node
. npm comes with node
We are on yarn 1.13
, npm 6
, and node 8-11
Make sure you have the correct yarn installed.
If none of the commands are working, like yarn -v
,
then uninstall that yarn and get the correct one
Clone the repository
git clone git@github.com:dog-house-development/poodl.git
Change directory to poodl
cd poodl
To install all dependencies, run:
yarn install-all
We keep our database key secret, ask doghousedevelop@gmail.com to join our slack to have access to our keys. Make sure you only use our dev database.
// config/secrets.js
module.exports = {
mongoURI: '<mongo database secret key>'
};
You can also start a local mongo database and use that key instead. See installing mongodb.
To start the development server, run:
yarn start:dev
Instead of adding a secrets.js file you can export the mongo uri as an environment variable:
export MONGO_URI=<mongodb uri> yarn start:dev
To run react component tests (located in sibling tests
folders of component files):
yarn test:client
To run API tests (located in /test/
):
yarn test:server
To run selenium tests (located in /test/selenium
):
Start the client app
yarn start:client
In a separate shell run the tests:
yarn test:selenium
To merge your changes into production, follow the merge strategy here.