Sectors Without Number

Revised edition compliant Stars Without Number sector generator.

Feature Requests & Bugs

Feel free to open an issue if there is a feature you'd like to see or something is broken. Pull requests are always welcome.

Development

This project is a front-end application written in React + Redux with a Firebase backend. For more information see create-react-app.

Getting Started

1. npm i and cd functions && npm i
2. cp .env.example .env
3. Create a firebase project
4. Create a Firestore Database (make sure it's of the "Cloud Firestore" database type.)
5. Create a web application (checking the box for "Also set up Firebase Hosting ...")
6. Navigate to "Project Overview" -> "Project Settings" -> scroll down to "Your apps" -> "Firebase SDK Snippet" -> click the "config" radio button and use the values displayed in firebaseConfig to fill out the values required in the .env file created in step 2 (be aware these values do not need to be closed with quotation marks in the .env file)
7. Ensure you enable authentication by navigating to "Develop" -> "Authentication" -> click "Set up sign-in method" -> choose google and/or email + password
8. $(npm bin)/firebase login or use your global firebase instance if you installed it globally (you might have to follow the google auth flow to authorize the firebase CLI)
9. $(npm bin)/firebase use --add and select the project you configured in the firebase console.
10. npm run deploy:functions to setup the cloud functions.
11. npm run deploy must be run at least once to create necessary configuration / rules files (also ships the app to firebase)
12. npm start to host the app locally

Deploying to Firebase

After you've logged into firebase and selected the project from the CLI, you can deploy by simply running npm run deploy.

Keep in mind that npm run deploy targets whichever project is currently active in the Firebase CLI (see .firebaserc / firebase use) — it does not read your .env files to choose the project. The .env file only supplies the REACT_APP_* values that get baked into the client bundle by react-scripts build; the Firebase CLI picks the deploy target independently.

If you maintain multiple environments (e.g. staging and prod), switch between them with firebase use <alias> before running npm run deploy, or use npm run deploy:prod which runs firebase use prod and sources .env.prod for you. Run firebase projects:list to see which projects your current account can access, and firebase login:list / firebase login --reauth if you hit permission errors like Failed to get Firebase project <id>.

Internationalization

Translations for all the strings on the site are in a google sheet. If you would like to help out just request access and tell me what language you'd like to work on.

Convert GDrive spreadsheet into intl files

1. Use ExportSheetData plugin (https://github.com/Synthoid/ExportSheetData) to export json from google sheets
2. Drop the downloaded file into the project's base directory
3. npm run translate, which will take this file and get the translations where they need to be