Giter Club home page Giter Club logo

techscrunch's Introduction

Banner

๐Ÿ“ฐ TechScrunch

Very relAIble open source alternative for TechCrunch.

TechScrunch logo

๐Ÿงฐ Tech Stack

๐Ÿ› ๏ธ Setup Server

  1. Setup Appwrite server
  2. Create project techCrunchs
  3. Install Appwrite CLI
  4. Login with appwrite login
  5. Enter cd appwrite
  6. Deploy initial setup and seeds sh seed.sh
  7. Set variables on deployed functions. There is appwrite/functions folder for each function. They all have README.md describing what variables they need
  8. Setup GitHub OAuth provider

๐Ÿ‘€ Setup Client

  1. Install libraries npm install
  2. Update endpoint in src/lib/AppwriteService.ts (Appwrite endpoint from server setup)
  3. Start server npm run dev

๐Ÿš€ Deploy client

  1. Deploy frontend and backend on the same domain. For example, techscrunch.dev and appwrite.techscrunch.dev
  2. Add frontend hostname as a platform in the Appwrite project

๐Ÿšจ Moderation

All moderation can be done in Appwrite Console.

๐Ÿค Contributing

To contribute to styles, update SCSS files in src/lib/styles. For state management, we use Svelte stores in src/lib/stores, and all Appwrite communication is kept in src/lib/AppwriteService.ts. To prevent code duplication, we make components out of reusable blocks in src/lib/components.

When contributing to backend-related logic, sync up appwrite/appwrite.json by running the appwrite init commands in the appwrite folder. Also, make sure to keep appwrite/seeds.json up to date with seeding logic for collections and buckets.

๐Ÿ–ผ๏ธ Screenshots

Screenshot Screenshot

๐Ÿค– Auto-generated documentation

Everything you need to build a Svelte project, powered by create-svelte.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

techscrunch's People

Contributors

meldiron avatar elad2412 avatar torstendittmann avatar tglide avatar eldadfux avatar christyjacob4 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.