Giter VIP home page Giter VIP logo

react-ci-project's Introduction

SnapJoy - Comprehensive Documentation

Welcome to SnapJoy! SnapJoy is an engaging photo-sharing application built with React and connected to the DRF_API server. This documentation provides comprehensive information to help you understand, set up, and contribute to the SnapJoy project.

Overview

SnapJoy is a vibrant photo-sharing application where users can create accounts, upload photos, and engage with the community through likes and comments. The project is based on the Moments project from the CODE Institute, customized and seamlessly connected to the DRF_API server.

Getting Started

Follow these steps to set up and run the SnapJoy React application.

Prerequisites

Ensure you have Node.js installed on your machine. You can download it here.

Installation

  1. Clone the SnapJoy repository:

    git clone https://github.com/lukaszglowacz/react-ci-project
    
  2. Navigate to the project directory:

    cd snapjoy-react
    
  3. Install dependencies:

    npm install
    
  4. Configuration

    Update the API base URL in the src/api/axiosDefaults.js file to point to your DRF_API server:

    // src/api/axiosDefaults.js

    import axios from "axios";

    axios.defaults.baseURL = "https://your-drf-api-url.com"; axios.defaults.headers.post["Content-Type"] = "application/json"; axios.defaults.withCredentials = true;

    export const axiosReq = axios.create(); export const axiosRes = axios.create();

  5. Running the aplication:

    npm start
    
    Visit http://localhost:3000 in your browser to explore SnapJoy.
    

Features

  • User Authentication: Create an account and log in to start sharing your moments.
  • Photo Upload: Share your favorite photos with the SnapJoy community.
  • Interactivity: Allow the community to engage by liking and commenting on your photos.

Connectivity with DRF_API

SnapJoy is seamlessly connected to the DRF_API server. Ensure that the DRF_API server is running and properly configured according to the instructions in its README.md file.

Credentials

The project is built based on the Moments application template created by Code Institute.

Contributing

Contributions to SnapJoy are welcome! Feel free to submit issues or pull requests to enhance the application's functionality and usability.

react-ci-project's People

Watchers

Lucka Baron 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.