Dexie.js: Dexie is not widely known.

[acicali]

This is the biggest issue with Dexie. SRSLY. I've been in search of Dexie for quite a while, but didn't know that it existed. Instead, I've spent many hours evaluating the alternatives mentioned here:
https://github.com/dfahlander/Dexie.js/wiki/Dexie.js#other-competing-indexeddb-wrappers

How can we solve this problem?

Thank you for this great creation.

[dfahlander]

Any suggestion is appreciated!

Thanks :)

[acicali]

Something more visual as a home for the project would be good, probably best to use github pages: https://pages.github.com/

I just registered dexie.org. I'll transfer it to you if you'd prefer, or I'll try and keep it renewed as long as I can afford it.

And I'm guessing this would be EASY to get towards the top of the search engines, as it's very niche. I simply search "indexeddb library" or "indexeddb wrapper" in google and Dexie is nowhere to be found. Still not even sure how I found it, but I'm glad I did.

[acicali]

Alright, I took a shot at putting something together: http://www.dexie.org/

Let me know your thoughts. It can stay where it is, I can take it down, we can change it. No biggie.

[dfahlander]

Like it a lot :)

I would be glad to take over payment ownership. Would love to let you continue having access to editing it. Feel free.

[dannyc]

Wow, awesome website landing page! Great move in the right direction. I found Dexie a few months ago by wading through the internal Github search results when I searched by indexedDB, since Google Search wasn't bringing up anything good. It's by far the most robust library out there.
I am using Dexie now in a production environment and very happy with it.
Besides for the awesome Where clause functionality the Documentation is the best thing Dexie has going for it (IMHO). While Github wiki get's the job done, it would be a nice addition to have the Documentation accessible on the new site in some easier to read fashion.
Anyways, thanks for the great library, and great initiative @acicali. Obviously a lot of hard work went into making this library and you're right, it deserves more recognition.

[matthew-andrews]

I've posted a link to that site from the top of an article I wrote a few years ago but (oddly) still gets quite a lot of traffic & high ranking on Google… http://labs.ft.com/2012/08/basic-offline-html5-web-app/ (Search for “html5 offline” or “offline website tutorial”)

I wonder if we could ask @chrisdavidmills for a Dexie mention on MDN?

[acicali]

It's hosted on a $5 Digital Ocean VPS... not sure what type of traffic it'll withstand. Probably it should be on github, then it'll remain with the project and anyone can collaborate.

https://pages.github.com/

I agree strongly about putting the documentation on the site. I'll try to put something together soon.

[chrisdavidmills]

I like the look of dexie, and am happy to give it a mention on MDN. The syntax looks pretty easy. Does it fallback to WebSQL/localStorage in non-IDB supporting browsers, like our localForage library does?

Let me know when you get the location updated; then I'll update our IDB reference with a link.

[matthew-andrews]

@chrisdavidmills I don't think the location is moving — even if they change the hosting it'll still be available on dexie.org.

Does it fallback to WebSQL/localStorage in non-IDB supporting browsers

It doesn't but I don't think it should (nor do I think localForage should either :wink:). A better pattern, in my opinion, is to only implement IndexedDB endpoints and then use the IndexedDB polyfill to provide the backwards support layer. The nice thing about that is once your WebSQL-only browser traffic disappears you just need to delete the polyfill. Also you could do something clever (a la cdn.polyfill.io) to only deliver the IndexedDB polyfill to those browsers that need it.

[dfahlander]

Iciali, it would be nice if we could move the content to Github pages and
use a DNS record to map dexie.org towards dexie.github.com. I followed the
github pages manual and added a branch gh-pages and added you as
collaborator. Would be great to have the site there so it is version
controlled together with Dexie.
Den 9 nov 2014 15:53 skrev "acicali" [email protected]:

It's hosted on a $5 Digital Ocean VPS... not sure what type of traffic
it'll withstand. Probably it should be on github, then it'll remain with
the project and anyone can collaborate.

https://pages.github.com/

I agree strongly about putting the documentation on the site. I'll try to
put something together soon.

—
Reply to this email directly or view it on GitHub
https://github.com/dfahlander/Dexie.js/issues/22#issuecomment-62305872.

[chrisdavidmills]

Ok, I've added a link to dexie.org to

https://developer.mozilla.org/en-US/Apps/Build/Offline
https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API
https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB

[matthew-andrews]

o/ Thanks @chrisdavidmills !

[dfahlander]

Thanks a lot for linking to dexie.org @chrisdavidmills !

@acicali - Skip my last post. We should instead create a new repo for the site rather than adding the pages to the existing dexie.js repo... Let's setup a new repo for it and a CNAME file into the repo. After that we just need to upload the content and add a CNAME record to the DNS for dexie.org. (https://help.github.com/articles/adding-a-cname-file-to-your-repository/)

Thoughts?

[acicali]

Sounds good to me. Will you create the repo please? This way you remain the owner.

[fimkrypto]

Wanted to add my 2 cents. Dexie is a truly amazing piece of tech and is already an important building block for one of our main products. Thank you for your hard work.

As for putting up a site on github pages you should have a look at http://jekyllrb.com/ I recently setup a gihub pages site (http://mofowallet.com) with that and it's a breeze. I made a separate repo for that, the gh-pages branch approach in your main project felt a little weird.

[jbergens]

It might help if more people would blog about it. It will probably also help if the library is used by other well-known projects. That might be hard to control but it would probably help a lot.

[YurySolovyov]

Logo idea:

[dfahlander]

Thanks for the logo suggestion. I think it's rather nice.

[brandonlamb]

This looks like a great thread to tag onto. Came across Dexie in my weekend of googling angularjs stuff and when I got to the point of needing client side data, Dexie was in many of my search results. So far based on my 30 minutes with it, two thumbs up! :+1:

[dfahlander]

@YuriSolovyov , could I use your logo? Is it okay if I change background to transparent and text to white? (would work better on the site)

[YurySolovyov]

@dfahlander, sure, do whatever you want

[YurySolovyov]

@dfahlander maybe I can even attach source .ps file when I get home later today.

[YurySolovyov]

@dfahlander here is the source
https://drive.google.com/file/d/0B4txOhp64viVdHg4MTJoaEVnSE0/view

[brandonlamb]

:+1: nice looking site

[dfahlander]

Thanks @YuriSolovyov , I've picked picked the graphics but kept the current font. Check out if you approve my changes on dexie.org

[dfahlander]

Ps. if you're on mobile, you can't see it because I hide it on small screens because the margin looked to bad there.

[YurySolovyov]

@dfahlander header icon looks good, but favicon feels cut off (right side of letter D)

[YurySolovyov]

@dfahlander how about this:

[dfahlander]

Thanks, much better!

[YurySolovyov]

Featured in Progressive Web Apps across all frameworks - Google I/O 2016

[nponiros]

I created a demo site which includes the docs from the wiki under http://dexie.flexisitegen.com/docs/Home . There are a number of broken links because not every wiki link matches a file name and I didn't try to convert the links to match the files but I guess for a demo it is good enough.

If this is a wanted change, I can create a PR for https://github.com/dfahlander/dexie.js-web to add the docs. Assuming that the docs should be on the website, then there is the question of whether the github wiki should continue to exist. If we have docs on the site and the wiki, we will have to decide which docs are the "master" docs. So basically which docs will be updated and which ones will just be created. Depending on that I can solve the links issues and the code highlighting issues (we use for example "js" in the wiki but prism requires "javascript"). Personally I would prefer to just have the docs on the website as I am not a big fan of wikis in general.

As always feedback is welcome :)

Edit: Having the docs outside the wiki will probably make it easier to coordinate pull requests for new features/API-changes and documentation update. Updating the wiki is instant and from what I know we can not update it after the PR changes were released meaning that the person who created the PR must wait until the release to update the docs. With docs on the website we can create a PR for dexie and a second PR for the docs and both can be released at the same time.

As a side note, I think we should also promote the various addons on the website and maybe in the readme. Perhaps under a "Features" section like: "Dexie supports client/server synchronization with Dexie.Syncable" or "You can use dexie-mongoify to have a MongoDB like API with Dexie".

[dfahlander]

That would be nice, to have the docs on the site. The only thing I would be missing would be the super simple way to update typos etc directly from the page. But maybe this could be accomplished by linking to the github's web based file editor for each file. In that case I'm for moving it to the site entirely and replace each MD file in the current wiki with a reference to the site.

Indeed the addons / derived libs including sync-client must be more aggressively promoted. Dexie's Readme is one good place. Could also link to api docs for addons from the documentation page or include docs as well optionally

[nponiros]

@dfahlander fixing typos directly on github should not be an issue, at least not for collaborators. If we write the docs in html then any change you make in the website repo should also be instantly online. If we write the docs in markdown we would have to have a build step. In this case the changes will only be online when you build the site and push the html files. I don't know if we can directly build from within github. Maybe that works with jekyll. So do you want to be able to just edit online and release later or do you want any change to be instantly online?

[dfahlander]

@nponiros I'd prefer editing MD files. Github has built-in jekyll support. Github will 'fix' the build automagically. https://help.github.com/articles/about-github-pages-and-jekyll/

[nponiros]

@dfahlander I am not familiar with jekyll. I used my own tool to build the demo site. It will take me some time to get familiar with jekyll (and github pages) but I can give it a try.

[dfahlander]

I just pushed a branch I made for some time ago for dexie.js-web. Check it out https://github.com/dfahlander/dexie.js-web/tree/jekyll

EDIT: I've now merged that branch into the main branch (gh-pages) of dexie.js-web. It's just a basic setup of jeykyll. Can be viewed at http://dexie.org/jekyll-index.html

[dfahlander]

Let's follow up the documentation move discussion on #464.

EDIT: Created a github project for the documentation move as well

[dfahlander]

README updated to promote addons in this PR https://github.com/dfahlander/Dexie.js/pull/465

It's just a draft.

Comments?

[douglasg14b]

@dfahlander You should add appropriate github tags to the project. So it is discoverable on GitHub, and can be recommended by GitHub.

Recommended:

database javascript indexeddb offline storage

[dfahlander]

I only know about the npm keywords that we list in package.json: ["indexeddb", "browser", "database"]. What are the github tags and how do you add them?

[douglasg14b]

@dfahlander you can do this with the manage topics button under the repository description

[dfahlander]

Thanks @douglasg14b! Topics now set.

[dfahlander]

This has been the nicest issue I've ever got <3
But I believe it is time to close it.
Dexie is now relatively known as of what I experience.
Thanks all! I'm keeping on maintaining it 👍