-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from costanzopa/develop
Release 1.0
- Loading branch information
Showing
7 changed files
with
52 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,89 +1,70 @@ | ||
# HolyGround | ||
# HolyGround | ||
|
||
The place where cosmic kites are born. | ||
A webpage to find all the football fields where the stars (or not) are born. | ||
The place where cosmic kites are born. | ||
A webpage to find all the football fields where the stars (or not) are born. | ||
|
||
## Getting Started | ||
## 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. | ||
- git clone https://github.com/costanzopa/HolyGround.git | ||
|
||
### Prerequisites | ||
### Prerequisites | ||
|
||
What things you need to install the software and how to install them | ||
- Install Node JS [https://nodejs.org/es/] | ||
- MongoDB [https://www.mongodb.com/es] | ||
|
||
``` | ||
Give examples | ||
``` | ||
### Installing | ||
|
||
### Installing | ||
- Go inside Holyground directory. | ||
- Run command line npm install | ||
- Create a directory call config | ||
- Inside this directory create dev.env and test.env | ||
- Add the following enviroment variables: | ||
- - PORT=3001 | ||
- - DATABASEURL=mongodb://localhost/holy_ground | ||
- - CLOUDNAME=holyground-dev | ||
- - APIKEY=Api key from cloudinary | ||
- - APISECRET= Api secret from cloudinary | ||
- - GEOCODER_API_KEY= Private key from google maps. | ||
- npm run dev | ||
|
||
A step by step series of examples that tell you how to get a development env running | ||
## Running the tests | ||
|
||
Say what the step will be | ||
- npm run test | ||
|
||
``` | ||
Give the example | ||
``` | ||
## Deployment | ||
|
||
And repeat | ||
- git add . | ||
- git commit -m "Message." | ||
- git push origin master | ||
|
||
``` | ||
until finished | ||
``` | ||
## Built With | ||
|
||
End with an example of getting some data out of the system or using it for a little demo | ||
- [NodeJS](https://nodejs.org/es/docs/) - The web framework used | ||
- [MongoDB](https://docs.mongodb.com/?_ga=2.172250912.2059563990.1559787459-1649167481.1559787459) - Database Engine | ||
- [CircleCi](https://circleci.com/docs/) - Continuous Integration server | ||
- [Heroku](https://devcenter.heroku.com/) - Platform as Service | ||
- [Google Maps](https://console.cloud.google.com) - Maps API | ||
|
||
## Running the tests | ||
## Contributing | ||
|
||
Explain how to run the automated tests for this system | ||
Please read [CONTRIBUTING.md](https://github.com/costanzopa/HolyGround/graphs/contributors) for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
||
### Break down into end to end tests | ||
## Versioning | ||
|
||
Explain what these tests test and why | ||
We use [Git](https://git-scm.com/) for versioning. For the versions available, see the [tags on this repository](https://github.com/costanzopa/HolyGround/tags). | ||
|
||
``` | ||
Give an example | ||
``` | ||
## Authors | ||
|
||
### And coding style tests | ||
- **Pablo Costanzo** - _Initial work_ - [HolyGround](https://github.com/HolyGround) | ||
|
||
Explain what these tests test and why | ||
See also the list of [contributors](https://github.com/costanzopa/HolyGround/contributors) who participated in this project. | ||
|
||
``` | ||
Give an example | ||
``` | ||
## License | ||
|
||
## Deployment | ||
This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the [LICENSE.md](LICENSE.md) file for details | ||
|
||
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. | ||
|
||
## 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 | ||
|
||
* **Pablo Costanzo** - *Initial work* - [HolyGround](https://github.com/HolyGround) | ||
|
||
See also the list of [contributors](https://github.com/costanzopa/HolyGround/contributors) who participated in this project. | ||
|
||
## License | ||
|
||
This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the [LICENSE.md](LICENSE.md) file for details | ||
|
||
## Acknowledgments | ||
|
||
* Hat tip to anyone whose code was used | ||
* Inspiration | ||
* etc | ||
## Acknowledgments | ||
|
||
- Hat tip to anyone whose code was used | ||
- Inspiration | ||
- etc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters