Golf Course of Ireland Readme
Table of Contents
-
About The Project
-
Getting Started
- Usage
- Contributing
- License
- Contact
About The Project
This site was developed as a POI web application for Golf Courses of Ireland. Users can use the app to add details of course courses
to the Database along with the coordinates of the course and some images.
Here are the main features:
- Authentication of users.
- A user can be a normal user who can add/update/delete course data
- Or a Admin user who has addition functionality around user admin and statistics. An admin user can see all normal user details and update and delete them.
They can check a users login count and last date of login. They also see stats on the number of POI golf courses added to the system.
- Authenticated users can add new course details, name description and coordinates.
- Authenticated users can update and delete course details
- They can add/delete images to/from the course listing.
- They can add new categories and update categories
- Courses can be filtered by category at the click of a button.
- On the edit course page the current course weather will also be displayed.
- There is a Map page which will display markers for all courses entered.
- Each marker has a link which will take the user to a Golf POI display page with a more detailed map
Built With
This section lists major platforms, frameworks and technologies that were used to build the project using.
This application has a number of API built using hapi which are being used by a Svelte Front end Application.
Getting Started
To get a local copy up and running follow these simple example steps.
- An .env file will need the following entries
- name=cloudinary User Name
- key=Cloudinary Key
- secret=Cloudinary Secret Key
- cookie_name=golfPOI-web
- cookie_password=a password
- db=mongodb://localhost/golfCoursePOI
- api_key=open weather api key
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
Installation
- Details to be added
- Clone the repo
git clone https://github.com/Davidcorrigan1/golf-courses-poi-v2.git
- Install NPM packages
npm install
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
)
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the Branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
License
Distributed under the WIT License.
Project Link: https://github.com/davidcorrigan1/golf-courses-poi-v2