Giter VIP home page Giter VIP logo

openplanner's Introduction

OpenPlanner

A website to

  • schedule accepted talks from ConferenceHall: pick date & time
  • talks and speakers:
    • manually add talks and speakers
    • pick specific talks from ConferenceHall afterward
    • edit talk or speaker, add profil picture, company logo, without editing data from ConferenceHall
  • a schedule calendar to arrange talks and duration
  • additional fields:
    • categories and formats for sessions
    • private notes for speaker, email, phone
    • tracks / rooms
  • manage sponsors & categories
  • FAQ with admin and public or hidden pages
  • API & webhooks

Dev guidelines

Project use:

  • TypeScript everywhere
  • Google Firestore (native) database
  • React
  • Firebase Hosting & functions

Core concepts:

  • write clear and readable codes without too much abstractions to be read by as many as possible.
  • use any library necessary to speed up devs BUT
  • try to minimize bundle size at all cost: prefer lightweight dependencies rather than big one, prefer tree-shaking js libs
  • have fun!

React guidelines:

Getting started

Requirements

  • Two firebase projects. One for open planner and the other for conference hall.
  • Node.js 20+
  • Bun.js as a build tool

Installation

  1. Create a .env with .env.example as a template.
  2. Create a web app in your firebase project for conference hall and open planner. then copy the config and fill .env with it.
  3. Use bun.sh to install dependencies and build the project: bun install

Inside OpenPlanner's firebase project:

  1. Create a Cloud firestore database and copy path the rules from firestore.rules to the rules tab of your database.
  2. Create an authentication provider (email/password) and enable it.

Development

In order to run the project locally, you need to run the following commands:

bun install # install dependencies
bun start   # start the dev server

Enjoy ๐Ÿš€

Scripts

The repo contain few scripts useful for:

openplanner's People

Contributors

hugogresse avatar malopolese avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.