In this lab, you'll be working to re-implement the ToDo API, this time pulling data from a Mongo Database rather than a flat JSON file. You will also be implementing a new summary API which returns results of processing ToDo data. You will also be implementing a simple client-side application to view this data.
Your specific tasks for this lab can be found in the LABTASKS.md file in this repository.
As in the previous labs, you'll be using IntelliJ. Once you've all joined your group using GitHub classroom, you can clone your repository using IntelliJ:
- When prompted to create a new IntelliJ project, select yes.
- Select import project from existing model and select Gradle.
- Make sure Use default Gradle wrapper is selected.
- Click Finish.
- If IDEA asks you if you want to compile TypeScript to JavaScript 🔥 DO NOT 🔥 it will break your project.
gradle, ng, and a thing called webpack which you
never explicitly see) to do that compilation. If you let IDEA do it, you'll
have a ton of JavaScript files cluttering up your project and confusing other
tools.
- The familiar run Gradle task will still run your SparkJava server.
(which is available at
localhost:4567) - The build (or its' alias buildExecutable) task will still build the entire project (but not run it)
- The runClient task will build and run the client side of your project (available at
localhost:9000)
The major difference between this lab and lab #3 is that, here, your data (users and todos) will be stored in a database rather than as "flat" JSON files within the server source code.
For the most part, you will be using a local installation of Mongo as a
dev (development) database. You don't really need to worry about how this is set up,
but you do need to know a couple of tricks to help you use it:
- To load new seed data into your local dev database, use the gradle task: seedMongoDB.
- Seed data is stored in the correspondingly named JSON files at the top
level (e.g.,
users.seed.json).
❗ Pro-tip: IntelliJ comes with a nice view to see the mongo databases setup. To access this click on File -> Settings -> Plugins, type Mongo and make sure the Mongo Plugin is installed. Now head to View -> Tool Windows -> Mongo Explorer. Then use the tool icon to add configuration. Once prompted type for Path to Mongo Shell: "/usr/bin/mongo" and hit the green ➕, to add your label and, huzzah!, Mongo Explorer is on your side bar.
Testing options are still integrated in this lab so you can test the client, or the server or both. Testing client:
- runAllTests runs both the server tests and the clients tests once.
- runClientTests runs the client tests once.
- runClientTestsAndWatch runs the client tests every time that the code changes after a save.
- runClientTestsWithCoverage runs the client tests (once?) and deposits code coverage statistics into a new directory within
clientcalledcoverage. In there you will find anindex.html. Right click onindex.htmland selectOpen in Browserwith your browser of choice. For Chrome users, you can drag and drop index.html onto chrome and it will open it. - runE2ETest runs end to end test for the client side. What are e2e tests? They are tests that run the real application and simulate user behavior. They assert that the app is running as expected. NOTE: Two Gradle tasks must be run before you can run the e2e tests.
The server (
run) needs to be on for this test to work, and you have to run theseedMongoDBtask before running the e2e tests! - runServerTests runs the server tests.
Turn on your repo in Travis CI, replace the build status image in this README, and push your changes. That will trigger a build with Travis.