├── CONTRIBUTING.md ├── README.md ├── instructions_1.gif ├── instructions_2.png └── public ├── 404.html └── index.html /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | We're always looking to improve this project, open source contribution is encouraged so long as they adhere to our guidelines. 3 | 4 | # Pull Requests 5 | 6 | The Solid State team will be monitoring for pull requests. When we get one, a member of team will test the work against our internal uses and sign off on the changes. From here, we'll either merge the pull request or provide feedback suggesting the next steps. 7 | 8 | **A couple things to keep in mind:** 9 | 10 | - If you've changed APIs, update the documentation. 11 | - Keep the code style (indents, wrapping) consistent. 12 | - If your PR involves a lot of commits, squash them using ```git rebase -i``` as this makes it easier for us to review. 13 | - Keep lines under 80 characters. 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Firebase auth starter 2 | This project is a template and step by step guide to customise confirm emails and reset password emails in firebase projects. 3 | 4 | 5 | # Getting Started 6 | 7 | ## Step 1 - Create a fresh copy of this repo 8 | ``git clone https://github.com/SolidStateGroup/firebase-project-starter.git && cd ./firebase-project-starter/ && rm -rf .git`` 9 | 10 | ** Add this folder to your project's source control ** 11 | 12 | ## Step 2 - Create a new firebase project 13 | https://console.firebase.google.com/ 14 | 15 | ## Step 3 - Add a profiles object to your database 16 | 17 | 18 | ## Step 4 - Deploy this project to firebase 19 | Go to Hosting > Get started > Follow the instructions for hosting 20 | 21 | **Select all defaults, make sure you select no when asked if you wish to overwrite index.html** 22 | 23 | # Step 5 - Set the email template action url (auth > email templates > customize action url in the bottom right of any of the templates) to your project url, enable signin providers you wish to use 24 | 25 | 26 | ## Step 6 - Use fireauth with project config 27 | For an example see https://git.solidstategroup.com/solidstategroup/ssg-frontend-boilerplate 28 | 29 | # Getting Help 30 | If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates. 31 | 32 | # Contributing 33 | For more information about contributing PRs, please see our Contribution Guidelines. 34 | 35 | # Get in touch 36 | If you have any questions about our projects you can email projects@solidstategroup.com. 37 | -------------------------------------------------------------------------------- /instructions_1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SolidStateGroup/firebase-project-starter/0cd0db6ee222490892e91a6bc708d450674057cd/instructions_1.gif -------------------------------------------------------------------------------- /instructions_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SolidStateGroup/firebase-project-starter/0cd0db6ee222490892e91a6bc708d450674057cd/instructions_2.png -------------------------------------------------------------------------------- /public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Page Not Found 6 | 71 | 72 | 73 |

Page Not Found

74 |

This specified file was not found on this website. Please check the URL for mistakes and try again.

75 |

Why am I seeing this?

76 |

This page was generated by the Firebase Command-Line Interface. To modify it, edit the 404.html file in your project's configured public directory.

77 | 80 | 81 | 82 | -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Confirm email 6 | 7 | 8 | 10 | 11 | 106 | 107 | 108 | 109 |
110 | 111 | 131 | 132 | 141 |
142 | 143 | 144 | 145 | --------------------------------------------------------------------------------