gen-self-service v1.0.0

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Run
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo, twitter_handle, email

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/github_username/repo.git

2. Install NPM packages

npm install

Run

To run, just npm start

npm start

Common running pitfalls

1. You receive an error mentioning an unexported component.

• Reason: We are using our own library for components, called generation-ui-components. This library is constantly under a lot of changes, so even if the package is on NPM already, we probably haven't deployed a latest version of the library.
• Fix: You have to link the library locally to this project. More info on this can be found in the library project README

2. Your graphql queries are failing to fetch any information.

• Reason: Your ENV variables may not be pointing to the API the dev team is currently using. Because of the nature of AppSync (and also a little bit of ignorance on our side), the API may be changing constantly.
• Fix: Ask your friendly developer peers whick API we are using. Go to AppSync console > Settings. Under API Details, check that the API URL is the correct one. Under API keys there should be one that expires within a year. Copy and use that one.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/github_username/repo

Acknowledgements