8000 GitHub - crypticzoologists/vendr: Greenfield Project
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

crypticzoologists/vendr

Repository files navigation

Vendr

Vendr is an auction site for buying and selling new and used items.

Table of Contents

  1. Usage
  2. Getting started
  3. Clone the latest version
  4. Install dependencies
  5. Run the application
  6. Tech Stack
  7. Team
  8. Contributing
  9. License

Usage

Landing Page: landing_page

Personal Page: personal_page

Sell an Item: sell_item

Search Results: search_results

Getting started

1. Clone the latest version

Start by cloning the latest version of Vendr on your local machine by running:

$ git clone https://github.com/crypticzoologists/vendr.git
$ cd vendr

2. Install Dependencies

From within the root directory run the following command to install all dependencies:

$ npm install

3. Run the application

  1. Run the following command in your terminal to bundle your files using Webpack:
$ webpack --watch
  1. Setup your mySQL connection by changing the password within db/config.js to match your local mySQL password

  2. 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.

Tech Stack

Front end:
  • React
  • Redux
  • Webpack
  • Babel
Back end:
  • Node
  • Express
  • Bookshelf/Knex
  • MySQL
  • Passport
  • Socket.io

Team

Contributing

  1. Fork the repo.
  2. Clone it to your local computer
  3. Cut a namespaced feature branch from master and name it appropriately
  4. Make commits and prefix each commit with the type of work you were doing
  5. BEFORE PUSHING UP YOUR CHANGES, rebase upstream changes into your branch, fix any potential conflicts, and then push to your fork.
  6. Submit a pull request directly to the master
  7. Someone else will perform code review to keep codebase clean
  8. Fix any errors or issues raised by the reviewer and push the fixes as a single new commit
  9. Repeat until the pull request is merged.

See CONTRIBUTING.md for contribution guidelines in detail.

License

M.I.T

About

Greenfield Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages

0