Giter Club home page Giter Club logo

appwrite-react's Introduction

Newsletter Form Application with Appwrite and React

Appwrite is an open-source application that is built on the concept of a self-hosted backend as a service server that provides user-friendly ways to build an application. It abstracts the time-consuming development tasks and provides pre-built SDKs to integrate your application with Appwrite APIs. It supports multiple languages and its UI is super cool to work with.

This repo contains the code for the Newsletter Application. I wrote a blog on it at Medium. Do check it out first as we would be using the concepts explained in that article. It would be helpful, if your are looking forward to using Appwrite in your next React application. I've explained about integrating Appwrite with React through its web client SDKs.

Screenshots:


app-ss1

app-ss2

app-ss3



Setup Instructions


  1. First you need to start Appwrite services (make sure you have Docker installed on your system)
  • Unix
docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:0.10.4
  • Windows

CMD

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:0.10.4

PowerShell

docker run -it --rm ,
    --volume /var/run/docker.sock:/var/run/docker.sock ,
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ,
    --entrypoint="install" ,
    appwrite/appwrite:0.10.4

Once the Docker installation completes, go to http://localhost to access the Appwrite console from your browser.

  1. Fork this repository. This will create a local copy of this Repository on your Github profile.

  2. Clone it

$ git clone https://github.com/<your-username>/appwrite-react  
$ cd appwrite-react
  1. Install the dependencies
$ npm i
  1. Inorder for the application to work, you need to take few ids from your project on Appwrite. Its detailed steps have been explained on my Medium article. Besure to check that out before you run your application.

  2. You need to create a .env file so that those ids and credentials could be appended in it and the React applciation could easily pick those from .env file.

$ touch .env
  1. Take reference from .env.example file

You would require following values:

REACT_APP_ENDPOINT=
REACT_APP_PROJECT_ID=
REACT_APP_COLLECTION_ID=
REACT_APP_USER_CREDENTIALS_EMAIL=
REACT_APP_USER_CREDENTIALS_PASSWORD=

You need to copy these into .env and take values from your Appwrite project which we had setup on my Medium article.

Dont get intimidated. These are very easy to extract. Just follow my Medium article and everything would fall in place.

  1. Now start the server
$ npm start
  1. To check the running application, go to http://localhost:3000

Demo

Demo video


Thanks for testing out my application. If you have any doubts then feel free to ask me on Twitter. My DMs are always open to interact with people 🙌

Inorder to understand the basics do checkout my article on Medium.

Developed with ❤️ by Pranav Singh 😎 👨‍💻

appwrite-react's People

Contributors

thebeginner86 avatar

Watchers

 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.