Git Product home page Git Product logo

athavani's Introduction

Athavani

πŸ“Œ Motive of the Project

Athavani or Memories is a full-stack MERN tool built which is used to save all your memories in a single place so that you can enjoy them throughout the year.

πŸ’‘ Project Background

The Project's Frontend is built with the help of Reactjs and Material-Ui and it is backed by Nodejs. Its Backend is built using Expressjs using MongoDB as a Database. The user has the following abilites:

  • Create a Memory
  • Update a Memory
  • Delete a Memory
  • Like a Particular Memory
  • Fetch all Memory at a Time

Technologies Used

A sneak peek into what we have hereπŸ™ˆ :

Creation of Memory

create memory

Updation of Memory

update memory

Like a Memory

like memory

Delete a Memory

delete memory

⭐ Getting Started

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

πŸ’₯ A guide for Contribution

PRs Welcome Open Source Love svg2

  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Read the Code of Conduct
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this Script is all about.
  • For more details visit the Contribution Guide

⭐ Contribution:

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/Athavani

3. Navigate to the project directory.

cd Athavani

4. Make a new branch

#Make a new branch to avoid conflicts with the main branch of repository
git checkout -b NewBranchName

5. Make changes in source code.

6. Stage your changes and commit

#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"

7. Push your local commits to the remote repo.

git push

8. Create a PR !

9. Congratulations! Sit and relax, you've made your contribution to Athavani project.

▢️ How to Run the Project

1. Navigate to the project directory.

cd Athavani

2. Navigate to the Client directory.

cd client
npm install
npm start / yarn start

3. Navigate to the Server directory.

cd server
npm install
npm start 

πŸ›ˆIMPORTANTπŸ›ˆ

To open the web app directly from CLI use:- explorer "https://memoriestejastapas.netlify.app/"

If you have cloned this repo, then open git in this directory and use ./script.sh

πŸ“’ Open Source Program

This Project is a part of the following Open Source Programs

Devscript Winter of Code GirlScript Summer of Code Lets Grow More Summer of Code

Levels & Points

Level Points
Level 0 5
Level 1 10
Level 2 15
Level 3 30
Level 4 45

⭐ Issues:

For major changes, you are welcomed to open an issue and discuss what you would like to contribute. Enhancements will be appreciated.

✨ Hall of Fame

❀️ Project Admin


Tejas1510

πŸ’»

❀️ Mentors

A special thanks to these awesome people who are really working hard for the project and helping the participants


sanjay270899


AmeyaJain-25

πŸ’»

Jassi10000

πŸ’»

ChitvanRamani22

πŸ’»

πŸ”” Credits

The project is built by learnings from JavaScript Mastery and various resources available on the internet.

built by developers built with love

athavani's People

Contributors

tejas1510 avatar ameyajain-25 avatar sanjay270899 avatar chitvanramani22 avatar kanishkaa24 avatar tejasbaaplms avatar ekjotkaur avatar 0xjaskeerat avatar shubhamsj07 avatar supzi-del avatar ashuto7h avatar archanakumari-ak avatar navdeepsingh4298 avatar heet-kumar avatar cgoyal48 avatar rishabhraghwendra18 avatar antaramunshi avatar khimit avatar ayushkwal avatar aniket31-coder avatar noir-07 avatar shubhraagarwal avatar sakshikhachane avatar vrushti24 avatar ritik-vashist avatar n-shar-ma avatar nancynegi23 avatar muthuannamalai12 avatar fomalhauting avatar himanshu007-creator 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.