Skip to content

TugOfWords/client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tug-of-words-client

This is the repository that holds the client-side code for our CS 408 Project, Tug of Words


Development

We will be using yarn rather than npm for dependency management.

Contributing to the project

  • First clone the repo git clone <project_url>
  • cd into the project directory, then install the dependencies yarn install

Running the client

  • To start the development server run yarn start
  • Note that the server automatically refreshes when you make changes

Adding a dependency

  • Always consult the team before adding a new dependency. If it is something small, you should write your own module instead of adding to the list of dependencies yarn add <dependency_name>
  • To add a developer dependency (such as testing framework) yarn add <dependency_name> --dev

Removing a dependency

  • Never remove a dependency you did not install yourself. Again, consult the team before removing a dependency. yarn remove <dependency_name>

Best Practices

  • Please follow the guidelines suggested here
  • If you are interested in reading more about react, here is a good compilation of resources

Testing

  • To run tests: yarn test

Linting

We are using eslint with enforced styles defined by Airbnb

  • To lint the entire code: yarn lint
  • You will not be able to commit code unless it passes the linter checks

Executable/Public Access URL

Our deployed project can be found at https://tugofwords.herokuapp.com/

The buggy version of our project can be found at http://bugofwords.herokuapp.com/

About

Client for Tug of Words

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •