Vendr is an auction site for buying and selling new and used items.
- Usage
- Getting started
- Clone the latest version
- Install dependencies
- Run the application
- Tech Stack
- Team
- Contributing
- License
Start by cloning the latest version of Vendr on your local machine by running:
$ git clone https://github.com/crypticzoologists/vendr.git
$ cd vendr
From within the root directory run the following command to install all dependencies:
$ npm install
- Run the following command in your terminal to bundle your files using Webpack:
$ webpack --watch
-
Setup your mySQL connection by changing the password within db/config.js to match your local mySQL password
-
In a new terminal window run the following command to start the application:
$ node server/app.js
After that open in your browser the localhost with your chosen port, e.g. http://localhost:3000/
to access the application.
- React
- Redux
- Webpack
- Babel
- Node
- Express
- Bookshelf/Knex
- MySQL
- Passport
- Socket.io
- Product Owner: Chris Ng
- Scrum Master: Will Tang
- Development Team Members: Chris Ng, Will Tang, Daniel Rabinovich
- Fork the repo.
- Clone it to your local computer
- Cut a namespaced feature branch from master and name it appropriately
- Make commits and prefix each commit with the type of work you were doing
- BEFORE PUSHING UP YOUR CHANGES, rebase upstream changes into your branch, fix any potential conflicts, and then push to your fork.
- Submit a pull request directly to the master
- Someone else will perform code review to keep codebase clean
- Fix any errors or issues raised by the reviewer and push the fixes as a single new commit
- Repeat until the pull request is merged.
See CONTRIBUTING.md for contribution guidelines in detail.
M.I.T