Skip to content

Latest commit

 

History

History
84 lines (73 loc) · 2.6 KB

README.md

File metadata and controls

84 lines (73 loc) · 2.6 KB
Raw

Tinder, but for Art

TindArt is a simple web app connecting artists and art enthusiasts in close proxmity using a tinder-esque matching style.

Getting Started

This app requires node v12.0 or higher.

  1. Install and run MongoDB on your local machine. Mongo should be listening on port 27017.
  2. Clone the repo
git clone https://github.com/isaaccormack/TindArt.git
  1. Install NPM packages
npm install
  1. Compile the TypeScript
npm run build-ts
  1. Start the application
npm start
  1. Navigate to the site on http://localhost:3000/

Running With Docker

  1. Clone the repo
git clone https://github.com/isaaccormack/TindArt.git
  1. Run docker-compose (install it if necessary)
docker-compose up
  1. Navigate to the site on http://localhost:3000/
  2. Take down the site
docker-compose down

Developing

For ease of development, running these two processes concurrently is recommended.

The TypeScript transpiler on watch mode, which transpiles TypeScript to JavaScript on every save

npm run watch-ts

and nodemon to refresh the server when new JavaScript is generated

npm run dev

Linting & Testing

To lint

npm run lint

To run unit and intergration tests (integration tests require a mongodb instance to be running on localhost:27017)

npm run test

Contributing

This app uses git flow branching. To contribute:

  1. Clone the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature'). If you don't want the CI pipeline to be re-run on your commit (for example, if you've only changed the docs), then add [skip ci] somewhere in the commit message.
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request