tanaypratap / polaris Goto Github PK

Requirement

favicon and icon is needed for the demo app. This is a subtask required to make the app PWA.

Tasks

1. Create icons in client folder.
2. Icons should be clean and should not infringe on copyright. Even a clear 'P' with a background is enough for demo purposes.
3. in client folder, create a public/images folder and create icons of these sizes required for PWA.

• 48x48
• 72x72
• 96x96
• 128x128
• 256x256

4. Create a 16x16 favicon.ico as well to be used as favicon.

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

Requirement

The app currently is bare minimum hello world of React. However, to add GraphQL, MongoDB we would need an app which actually has some functionality and data to hold on to. Simple idea is Todo app, if you have another idea please comment.

Tasks

1. Replace the bare minimum app with a Todo app.
2. It should have some data. Keep the data structure in a JS array for now. This will go to MongoDB through Express>>GraphQL>>Mutation route.
3. It should have some state change functionality. Use setState for now. This will be changed when Apollo is introduced.
4. It should have more than one component. You can show/hide for now using setState but this will be changed after React Router 4 is introduced.
5. Make sure code is commented as to which part will be replaced by which library so that future PRs can take a note.

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

name: Project Restructure
about: Currently client and server use the same package.json file. Having these separated will give a better developer experience.

1. Add Jest
2. Make sure it works in TypeScript
3. Add script entry in package.json to run tests
4. Add docs how-to-add-tests.md for future users to add new tests and things to keep in mind, troubleshooting tips and corner cases to take care.

Note: In case you publish a blog around it, please provide a link to it later creating a new PR again.

Requirement

Currently the typescript express server is getting compiled to JS and then you can run it using node or pm2 on the server. Typically in a production environment you would use some process runner which runs only JS code.

Tasks

1. Suggest a way where this compilation to JS is not needed.
2. Add a how-to-run-in-production.md in docs folder.
3. Delete the server folder with JS code.
4. Add npm script in package.json to run it in dev and prod mode.

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

Requirement

The index.html is currently bare-bones. However, to be used in production it needs tags for viewport, it needs tag for twitter, facebook, apple, site-url etc.

Tasks

1. Add tags which make it mobile friendly, and SEO friendly. If website name is required you can use a placeholder i.e. https://polaris2018.com
2. Add a seo-mobile-friendly.md in docs folder giving little bit of explanation about the meta tags being used so that it can help future users.

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

1. Support for TSLint.
2. .vscode settings to make it easy for vscode users to get tslint.
3. Add documentation on how to get tslint working for everyone working on the project.
4. create npm script entry for fixing common tslint errors. "format": "tsint --fix .",

Requirement

The resources files in docs/pwa has direct links. It would look better if we provide headings to all the links.

Tasks

1. Put Headings by going to website and reading what is about.
2. Add text if possible about the resources

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

Requirement
Circle CI is free to use with Open Source Github projects. This project has tests which could use to maintain that the project is running properly. Need integration with Github to run the CI tests after every PR is generated.

Tasks

1. Create circle ci entry for this project
2. Add how-to-do-continuous-integration in docs folder so that more tasks can be added later.

Additional context
This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

I am unsure as to which framework to choose for Testing for express. Need ideas, and few example tests to be setup on the server side.

I see three work items for this issue:

1. Which framework to chose and why we chose that? Put arguments of choice in a .md file.
2. Create few dummy APIs on the server side and write example tests for it.
3. Create an npm script entry to run tests.

Requirement

Manifest.json file is needed for app to be treated as PWA.

Tasks

1. Create manifest.json file. See examples here:

• https://developer.mozilla.org/en-US/docs/Web/Manifest
• https://developers.google.com/web/fundamentals/web-app-manifest/

2. Add manifest.json file to index.html
3. Run app in chrome, use Lighthouse to check if it passes manifest test. Post a screenshot in your PR description.
   Since, icons are not there currently to put in manifest.json feel free to use one image for all resolutions. Issue #14 can be tracked for getting icons also incorporated.

Please Note

This issue is being tagged as hacktoberfest and thus seeing a lot of traffic. If you're going to work on it and raise a PR, please comment. First preference to merge the project will be given to the first comment. However, the person has 24 hours of time to raise the PR. After that, the issue will be open for contribution again.

Readme file has technologies mentioned which will be used in Polaris. Need someone with markdown skills to put links to all the official websites of the docs.

For CSS pre-processing add PostCSS support in webpack.config file. Add a PostCSS loader.
Add some small CSS change and check if it's working.

website for PostCSS: https://postcss.org/
PostCSS loader for webpack: https://github.com/postcss/postcss-loader

Raise an initial PR early if you're going to work on it so that others don't work on it.

1. Add RR4 support.
2. Create two example React Components: Home and About (content can be taken from project readme)
3. Create Nav Bar on top and handle routing through React Router.
4. Add a how-to-add-routes.md doc for other people to use React Router.

Note: Use HTML5 routing, no hash required.