Skip to content
Markdown writing application that's down right, neat.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
api About page words (#147) Feb 17, 2019
client Dropdown styling (#156) Feb 17, 2019
integration
.gitignore Tests plus docs (#101) Oct 22, 2018
.nowignore
.travis.yml
.yarnrc Ci deployment (#109) Nov 6, 2018
LICENSE
Readme.md adding danger (#121) Jan 13, 2019
dangerfile.ts
now.json
package.json
rules.dev.json
tslint.json About page words (#147) Feb 17, 2019
yarn.lock

Readme.md

Downwrite

Build Status jest style: styled-components

About 🤔🦄🎉

A place to write. ✍️

So the idea here was simple build a simple markdown writing application. Markdown is a huge deal and all the cool tools kept getting shut down and naively,I thought, how hard can this really be? 🤔📝📦

So I've had poorly designed iterations of this thing for every year, on the year as one of these services got shut down. When Canvas shut down this last year, I started to get a little more serious about this idea. 💡🔭

During planning out some of my quarterly goals at my last job I decided to go a little more full-stack with Node and start to really work through the process of building a microservice. Since I'm never really one to learning languages and frameworks in the abstract, I decided to take up Downwrite as an excuse to build those microservices. 📡💸🌎

Why Markdown 🧐🤨📋

Markdown is probably the most efficient and universal tool for conveying syntax, semantics and structure across platforms. ⬇️

Originally coined by John Gruber (Daring Fireball) it was originally conceived as a text to HTML and is the staple of static site generators, OSS as well as a fair amount of comment sections, notetaking applications or any documentation tool. 🛠

These shortcuts are almost as ubiquitous as cmd + b for bold or cmd + i for italics. ⌨️

Bottomline: markdown is data. It is a method for describing semantics of data and is data itself.

Features 🔥🚀

This is meant to be a simple writing application with some key features:

  • Write wherever you are (even offline) in markdown
  • Share what you've written if you want
  • Upload a markdown file from your machine
  • Export to a static markdown file for your blog, etc.

Setup 📲⚙️

This project uses Yarn Workspaces and is written mostly with TypeScript.

brew cask install yarn
yarn

Client ⚡️🦊

Logos for Related Projects

Working on this Project

Run in your terminal from the root of the project.

yarn workspace client dev

Open http://localhost:3000 in your browser.

Info 📝

This is the client-side of the application. It uses Next.js and Express and uses this example to handle routing to different views. 👨‍💻🤜🦑🤯

Downwrite needs to server side rendered to make sharing an entry as easy as possible. Next.js' data-fetching API makes it the perfect candidate. The Express server also proxies the API server localhost:4000 under the hood. So when the page calls Component.getInitialProps() it fetches the data from the API server and for the initial render it has data available instead of a skeleton screen. 🤖☠️💀

For the Editor this project uses Draft.js and Draft.js Plugins. Markdown syntax is used inline and autogenerates the related rich text _hello_ becomes "hello" as you type.💻⌨️🔏

For styles I've used Aphrodite, JSXStyle, glamor, and styled-components 💅. Most components are just styled.div``; managing class names hasn't really ever been my thing. The styling also includes a Night theme that's managed through styled component's <ThemeProvider> and localStorage. 🌘🌛🌌 So it only ever renders on the client.

This project is a PWA, it uses some basic service worker implementation and manifest.json managed by next.config.js.

Related Documentation 📚

API 🌎

Logos for Related Projects

Working on this Project

Docker 🐳🐋

cd api
docker-compose up --build -d

or run the server locally 👨‍💻

yarn workspace api dev

This project depends on MongoDB 🍍 so if you're not using Docker 🐳🐋 locally, you should see this gist on how to setup MongoDB on your machine.

Info 📝

Using Gapi allows you to organize your endpoints very easiy and all the controllers are async so making database queries are fast and clean. All the routes are kept in ./api/src/routes.ts. 🛣

This service handles authentication with JWT and basic CRUD functions. 🔐

You can see the documented endpoints at http://localhost:3000/docs

Using a serverless model Hapi's API allows us to expose our server as a single function that we can inject the current header, url and method into to return a result to send back. This let's us use Hapi a serverless function gets executed dynamically and on-demand to minimize the cost. It could be ported to be used on the serverless framework or AWS Lambda.

export default async (req: http.IncomingMessage, res: http.ServerResponse) => {
  // This function adds the Routing and Plugins for Hapi and returns that server
  const server: Hapi.Server = await createServer();

  const injection: Hapi.ServerInjectOptions = {
    method: req.method,
    url: req.url,
    headers: req.headers
  };

  const response = await server.inject(injection);

  return response;
};

In development, I've been using Micro to replicate this locally.

Related Documentation 📚

Integration Testing 🌈🦁🐛

Logos for Related Projects

Working on the Project

yarn workspace integration test

Info 📝

Short hand: page is just a representation of whatever the headless browser, Puppeteer has rendered at that given moment.

Using Puppeteer I write assertions like this:

describe("Feature", () => {
  it("does this thing", async () => {
    await page.waitForSelector("#selector");
    await page.click("#selector");
    await page.waitForSelector("#other-selector");
  });
});

This approach accomplishes two things:

  • Ensures if an await statement errors or catch() the block will cause a failure
  • Makes the test sequential and simpler to write

Related Documentation 📚

Workflow 👷‍♀️🚧

Logos for Related Projects

Working on this project uses Travis to run the tests and deploy the successfully built workspaces to their given endpoints. It uses now for deployments for easy rollback and immutable deployments.

License ⚖️💣🛡⚔️

MIT License

Copyright (c) 2018 Charles Peters

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.