Skip to content

Latest commit

 

History

History
190 lines (140 loc) · 6.77 KB

README.md

File metadata and controls

190 lines (140 loc) · 6.77 KB
Raw

Lorem Travels

A Totally (Not) Real Travel Agency

GitHub Website



About The Website

  • It is a sample travel agency website and does not refer to any particular agency and/or company in real life. Hence, the generic title 'Lorem Travels'
  • The webapp consists of multiple pages (routes: / & /pricing as well as the routes for the different packages; following the format /pricing/{slug})
  • Statically generated (SSG)
  • Works offline (requires the pages to be loaded before at least once, in order to facilitate browser caching)
  • Can act like an e-commerce store (payment powered by Stripe API)
  • Privacy friendly analytics (with GoatCounter)
  • Mobile responsive
  • Page transitions

Technologies Used:

  • React
  • Gatsby
  • Webpack (default bundler)
  • Material-UI and styled-components
  • Stripe API
  • GoatCounter (for analytics)
  • Cypress (for end-to-end testing)

Installation and Running

    # To install the app:
    git clone https://github.com/AdityaBhattacharya1/lorem-travels
    cd lorem-travels-gatsby

    # To run the app:
    # If you do not have gatsby globally installed:
    npm develop

    # If you do have gatsby globally installed (preferred):
    gatsby develop

Testing

    npm run test:cypress

Usage

To set up analytics, first go to the GoatCounter and set up your account. Then, copy the link given and paste it in ./lorem-travels-gatsby/src/components/Layout.js as follows:

Layout.js
---------

// inside the <Helment> component
// Your link should look something like this:
// https://<USERNAME>.goatcounter.com/count 
// where <USERNAME> is the username with which you signed up to Goat Counter
<Helmet>
     <script data-goatcounter=<YOUR LINK HERE>
        async src="//gc.zgo.at/count.js"></script>
    ...
</Helmet>

In order to disable analytics completely, just comment or delete the script tag.

To edit the data (testimonial accordion, introductory paragraphs and/or package cards):

cd .\lorem-travels-gatsby\src\components\data

# To edit intro data:
cd introData.js

# To edit accordion data:
cd accordionData.js

There, you will find the data in the form of a JS object.
Edit the key-value pairs to obtain the desired output.

To Edit Pricing Data and Create New Pages For the Respective Packages

  • Go to the packages directory (path from main directory: ./lorem-travels-gatsby/src/packages)
  • Add a new .md file (the file name does not matter)
  • Copy the data present within the double hyphens (--) from the pre made .md files (Important step)
  • Edit the title, slug, desc, price, priceURL* and thumb**
  • After that, leave a few lines for good measure and edit the document as you wish. Ensure that the text follows markdown syntax.
  • And, you are done. You can now find a new card on the pricing page and if you click on it, you should be redirected to a new page

(*) priceURL is necessary for accepting payment. Go to next section for more details about making the website into an e-commerce store
(**) What Do These Terms Mean?

  • slug
  • thumb refers to the thumbnail or image which is displayed on the cards as well as the respective package website. Adding the URL to the image is required, or you might incur an error.

To Use E-Commerce Functionalities

To add your own products and be able to accept payment via Stripe API, follow these steps:

  • Make an account on Stripe and fill in the necessary details. Then, activate your account.
  • Go to Developers > API Keys, turn on live data and copy the publishable key (for safety reasons, try to avoid the secret key)

  • Go to Checkout settings and enable Checkout client-only integration
  • In the root of the folder .\lorem-travels-gatsby\ create a .env file.
  • Follow this format in your .env file:
.env file
---------



SUCCESS_URL="https://lorem-travels.vercel.app"
CANCEL_URL="https://lorem-travels.vercel.app/pricing"
  • Go to ./lorem-travels-gatsby/src/utils/stripejs.js and enter your own publishable key (from step 2) like this:
const getStripe = () => {
	if (!stripePromise) {
		stripePromise = loadStripe('<YOUR PUBLISHABLE API KEY>')
	}
	return stripePromise
}

  • Remember about the priceURL in the packages folder? Go to products page and create packages corresponding to the different packages (which were previously created here)

  • Now, go to the .md files of the packages and fill in the priceURL with the API ID of the respective packages

- The website is now ready to accept purchases for the packages.

Live Demo

Website is up and running, hosted at Vercel.

Credit

Hero page design

Images

License: MIT

MIT License

Copyright (c) 2021 Aditya Bhattacharya

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.