Trelloid API

Summary

• API for Trelloid application
• Version v0.3.0

Getting Started

Prerequisites

1. Install MongoDb
2. Install Node.js with a version >=11.0.0. This is because the version of package readline has dependencies on v11.0 or higher. The package will warn you during installation if the installed version of Node is incompatible.

Installing

• This is straightforward to set up.

1. Clone the repo.
2. Then $ cd express-search
3. Run npm install

Usage

5. To start api server run npm start.

Use Postman or your favourite API test tool. An example test url is http://localhost:3000/search/users?q=grif which will return all users with grif in one of collections fields.

Prerequisites

Running the tests

Break down into end to end tests

Explain what these tests test and why

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• React
• Redux
• Redux Thunk
• Webpack
• Jest
• Enzyme
• Eslint
• Prettier

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Andy Smith - Initial work - Boosmith

See also the list of contributors who participated in this project.

License

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc