From d9f9148328c08f2b1801bc251e2cc14bc7850a65 Mon Sep 17 00:00:00 2001 From: ubeb24 <139187554+ubeb24@users.noreply.github.com> Date: Mon, 18 Dec 2023 11:36:10 -0500 Subject: [PATCH] Update README.md Initial additions to our readme. Working on outlining, general descriptions, and inclusion of basic information about dependencies and install/execute directions. Needs more work and details, will fix later. --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0f4bfb..01c8fe5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# ncjs -LaunchCode LiftOff Project +# Travel Diary +From the members of ncjs, our project serves as a personal portfolio/digital scrapbook for trips that our users take. We think that having an application dedicated to storing vacation/trip memories would be great in comparison to scrolling for miles in your photos to find the one you’re looking for. We’ve developed an app that creates an unique folder for each trip the user has taken that stores photos and trip descriptions in each folder. Be the main character in your journey! + +## Description + +### Dependencies +* Thymeleaf +* Springboot +* MySQL +* Hibernate +* Gradle +* Java +* Javascript + +### Installation +Feel free to download our application to your local machine! +* Fork this repository to create your own branch to your local system. + - Download an integrated development environment that can read java- we recommend IntelliJ which we used to make this application. + - Clone the repository using the HTTPS link either by accessing program through version control link on your software or using terminal. + - Please download dependencies as stated above in the Dependencies section. Else, program might not run. + +### Execution +For now, our development team is still working on deployment strategies. _The only way to execute code is to run a bootrun program through Gradle to access in your localhost._ Please contact us if you'd like to booster your coding portfolio and contribute to the deployment of our application! If you're interested in our mission and you got the skills, we would love to talk about having you on our team :^) + +## License +This project is licensed under the MIT license--please see our license file for more information!