Git Lab CI for docker build enabled! You can enable it using .gitlab-ci.yml in your project. Check file template at https://gitlab.bio.di.uminho.pt/snippets/5

Commit 540d74c5 authored by Diogo Batista Lima's avatar Diogo Batista Lima
Browse files

Update README-Template.md

parent 2313e582
Pipeline #33 failed with stages
# Project Title
# Blueprint Repository
One Paragraph of project description goes here
## 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.
### Prerequisites
What things you need to install the software and how to install them
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
So far, the only prerequisites are Neo4j and Python.
End with an example of getting some data out of the system or using it for a little demo
To install Python, access the following link:
## Running the tests
https://www.python.org/downloads/
Explain how to run the automated tests for this system
To install Neo4j, access the following link:
### Break down into end to end tests
https://neo4j.com/download-thanks/?edition=community&release=3.4.10&flavour=winzip&_ga=2.66976166.909941613.1542910944-847881713.1541509905
Explain what these tests test and why
On Windows:
```
Give an example
```
Access the comand line and type the following commands:
`<NEO4J_HOME>\bin\neo4j install-service.`
`<NEO4J_HOME>\bin\neo4j start`
### And coding style tests
Visit http://localhost:7474 in your web browser to visualize the database.
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
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
* [Python](https://www.python.org/downloads/) - Used programming language
* [Neo4j](https://neo4j.com/) - Database framework
* [neo4j-driver](https://pypi.org/project/neo4j-driver/) - Python driver to interact with database
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc
* **Diogo Lima**
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment