cook-a-gram

Social picture sharing app

• Live demo - Live demo username: tester, password: mysupersecret
• Documentation - Documentation index

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Built with

What tech have been used in this project serverside

• Java JDK - Java Platform lets you develop and deploy Java applications on desktops and servers.
• Spring Boot - Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications.
• PostgreSQL - PostgreSQL is a powerful, open source object-relational database system.
• Maven - Apache Maven is a software project management and comprehension tool.
• Thymeleaf - Thymeleaf is a modern server-side Java template engine for both web and standalone environments.

Prerequisites

See Built with section

Installing

A step by step series of examples that tell you have to get a development env running

git clone https://github.com/leevilehtonen/cook-a-gram.git //or with ssh
cd cook-a-gram
mvn spring-boot:run

More in about how you can run spring-boot application, see: Spring Docs: Running your application

Running the tests

mvn clean test

Deployment

For running production java:

java $JAVA_OPTS -Dspring.profiles.active=production -Dserver.port=$PORT -jar target/*.jar

For running with Maven:

mvn spring-boot:run

If you want to deliver your own copy of cook-a-gram, it's very easy to serve at Heroku as procfile is attached in repo

Contributing

Make merge ready PR or contact me with feature suggestions.

Authors

• Leevi Lehtonen - Initial work - LeeviLehtonen

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

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments