fcatania / team-number-one

Squeaker, a better Twitter

Team

• Moises Munoz
• Felipe Catania
• Justin Yoo
• Henry Chesnutt

Table of Contents

1. Requirements
2. Development
   1. Installing Dependencies
   2. Setting up Dev Environment
3. Roadmap
4. Contributing
5. Testing

Requirements

• Node
• Nodemon
• MySQL
• Webpack

Development

Installing Dependencies

From within the root directory:

npm install

Setting up Dev Environment

From within the root directory:

npm run dev:react
nodemon server/index.js

These lines will make webpack and nodemon watch on changes to restart the server and re-bundle webpack's bundle.js file.

Roadmap

View the project roadmap here.

Contributing

See CONTRIBUTING.md for contribution guidelines.

Testing

See TESTING.md for testing guidelines.