Skip to content

coddit/codespace

Repository files navigation

asperitas new github desktop

Asperitas is a full stack reddit clone that I wrote to learn more about Node.js, React, and NoSQL databases. The name asperitas comes from a type of cloud. Edit from vscode

Installation

Prerequisites

  • node
  • npm
  • mongodb
  1. Clone this repository

  2. Install server dependencies

    $ npm install
  3. Install client dependencies

    $ cd client
    $ npm install

Run the app

  1. Start mongodb locally
    $ mongod
  2. Start the server
    $ npm start
  3. Start the client
    $ cd client
    $ npm start
  4. Browse to http://localhost:3000/

MongoDB Cloud Config

By default the server will be connected to local mongod server. But if you want to connect a cloud MongoDB create a environment variable called DATABASE_URL and puth MongoDB Cloud URI as its value.

Email Handler Config

For email handling server is using SendGrid: https://sendgrid.com/

To configure you need to add these environment variables:

  1. SENDGRID_API_KEY (The API key provided by sendgrid)
  2. SENDGRID_SENDER (Sender email address of the app)
  3. SERVER_URL (Complete url of server e.g http://localhost:8080 for properly managing redirections and links)

Testing

Server

Make sure mongodb is running before testing the server.

$ npm test

Client

$ cd client
$ npm test

License

This project is made available under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5