Create github page for the project

ngx-rocket / generator-ngx-rocket

:rocket: Extensible Angular 14+ enterprise-grade project generator

https://ngx-rocket.github.io/

MIT License

1.53k stars 216 forks source link

Create github page for the project #11

Closed sinedied closed 4 years ago

sinedied commented 7 years ago

As the issue on the website was lost, I'll recap here the remaining task for the website:

Tasks:

[ ] Add open graph meta tags
[ ] Add addons page to list available addons on NPMs, filtered by a static json blacklist
[ ] Add form (google forms?) to submit person/companies using the project
[ ] Add blog tab that redirects to ngx rocket
[ ] Use hashbang routing instead of HTML5 mode to fix F5 issues (to be replaced later by a proper NodeJS server acting as a reverse proxy?)

Old issue description:

Setup a Jekyll template for github pages deployment
Write some promotion/communication stuff about the goals and benefits

For the design, use these for inspiration: http://fountainjs.io, https://github.com/CloudCannon/cause-jekyll-template, https://github.com/CloudCannon/hydra-jekyll-template

The idea would be to have a nice 1-page website with scroll hooks and links to github/npm etc.

sinedied commented 7 years ago

@gaetanmaisse would you like to give it a go?

gaetanmaisse commented 7 years ago

@sinedied, I won't have enough time to work on it before a while... so I unassigne me this issue

japf commented 7 years ago

I'm playing a lot with Hugo lately. If you think that would be a good option I might work on this to have a landing page built with Hugo. The advantage of using Hugo is that we could also reuse the docs that are in Markdown in this repo to include them in the website.

Hugo supports a bunch of themes and I think we should find that fits the need of the starter-kit. Some examples:

Universal

Hyde-Y

Elate

Let me know your thoughts :-)

sinedied commented 7 years ago

Seems like a great idea! 👍

I was thinking of Jekyll because of the native Github integration, but Hugo would also be a good fit.

For the theme, I like the Universal you mentioned, and I also the simplicity of the creative. Any other opinion?

japf commented 7 years ago

For any options we will need to have a nice background image.

@sinedied is there any chance you could take a nice screenshot of your dev environment when working on the starter-kit? Something with the IDE + plenty of code and cool dev stuff :-) Using bit of blur + transparency that should do the trick to have a background we can use in the teme.

sinedied commented 7 years ago

@japf I'll do this and post it here

sinedied commented 7 years ago

Would something like this do the job? ngx

With 40% black overlay: ngx-black40

I have higher-res (x2) images if needed.

sinedied commented 4 years ago

As the website is live since a while, I think it's time to close this one 😄