Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.58 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.58 KB
Raw

Nightsky

Nightsky is a web client for Bluesky and other services based on the AT Protocol.

The project was scaffolded using Vite's React TypeScript template. It is styled using Tailwind CSS with the daisyUI plugin and heroicons. Routing happens with React Router.

At this time, this app is served on GitHub Pages so that its source code can be trusted. This limits it to a static site implementation only.

Setup

Set up Node.js 18 and npm 9.

Use npm for dependency management:

npm install

Development

To start the dev server, run:

npm run dev

This app is hosted on GitHub Pages. To preview the output for Pages, create a build and run the preview script to serve it locally:

npm run build
npm run preview

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Roadmap

Here's an unprioritized list of tasks to do:

  • Add Search page
  • Add Notifications page
  • Add Settings page
  • Support light mode with override in settings page
  • Offline mode with cached data
  • Move these TODO items to GitHub Issues once the repo is more stable